/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: Xavier Maillard
  • Date: 2008-03-26 06:21:48 UTC
  • mto: (3322.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3323.
  • Revision ID: xma@gnu.org-20080326062148-f7mnwvttv4oq8013
Add mail-mode GNU Emacs mail package as a mail_client option.
    
Idea and original code by Bojan Nikolic modified in this way:
    
1. define a different python class EmacsMailMode
2. use mail-mode package instead of message-mode. mail-mode is the
   default mail mode in GNU Emacs.
3. put the patch as a MIME attachment (see NOTE)
4. add tests as required to fulfil merge strategy requirements
    
To use this option, just put these lines into ~/.bazaar/bazaar.conf
    
[DEFAULT]
mail_client = emacs-mailmode

NOTE: this will work only for GNU Emacs version from 22.1 and superior.
      The MIME attachment is handled by etach[1] package. Just put
      etach.el into your `load-path'. GNU Emacs is not shipped with a
      simple MIME package thus the need of a simple and reliable
      alternative (etach does both reading and writing of MIME objects).

[1] http://rulnick.com/etach/download

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/xml_serializer.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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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.serializer import Serializer
26
 
from bzrlib.trace import mutter
 
25
from bzrlib import registry
 
26
from bzrlib.trace import mutter, warning
27
27
 
28
28
try:
29
29
    try:
34
34
    except ImportError:
35
35
        from cElementTree import (ElementTree, SubElement, Element,
36
36
                                  XMLTreeBuilder, fromstring, tostring)
37
 
        import elementtree.ElementTree
 
37
        import elementtree
38
38
    ParseError = SyntaxError
39
39
except ImportError:
40
40
    mutter('WARNING: using slower ElementTree; consider installing cElementTree'
49
49
from bzrlib import errors
50
50
 
51
51
 
52
 
class XMLSerializer(Serializer):
53
 
    """Abstract XML object serialize/deserialize"""
54
 
 
55
 
    squashes_xml_invalid_characters = True
56
 
 
57
 
    def read_inventory_from_string(self, xml_string, revision_id=None,
58
 
                                   entry_cache=None, return_from_cache=False):
 
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)
 
61
 
 
62
    def read_inventory_from_string(self, xml_string, revision_id=None):
59
63
        """Read xml_string into an inventory object.
60
64
 
61
65
        :param xml_string: The xml to read.
66
70
            serialised without a revision identifier can be given the right
67
71
            revision id (but not for working tree inventories where users can
68
72
            edit the data without triggering checksum errors or anything).
69
 
        :param entry_cache: An optional cache of InventoryEntry objects. If
70
 
            supplied we will look up entries via (file_id, revision_id) which
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.
76
73
        """
77
74
        try:
78
 
            return self._unpack_inventory(fromstring(xml_string), revision_id,
79
 
                                          entry_cache=entry_cache,
80
 
                                          return_from_cache=return_from_cache)
 
75
            return self._unpack_inventory(fromstring(xml_string), revision_id)
81
76
        except ParseError, e:
82
77
            raise errors.UnexpectedInventoryFormat(e)
83
78
 
122
117
    }
123
118
def _escape_replace(match, map=escape_map):
124
119
    return map[match.group()]
125
 
 
 
120
 
126
121
def _escape_attrib(text, encoding=None, replace=None):
127
122
    # escape attribute value
128
123
    try:
153
148
    }
154
149
def _escape_cdata_replace(match, map=escape_cdata_map):
155
150
    return map[match.group()]
156
 
 
 
151
 
157
152
def _escape_cdata(text, encoding=None, replace=None):
158
153
    # escape character data
159
154
    try:
175
170
elementtree.ElementTree._escape_cdata = _escape_cdata
176
171
 
177
172
 
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)
 
173
class SerializerRegistry(registry.Registry):
 
174
    """Registry for serializer objects"""
 
175
 
 
176
 
 
177
format_registry = SerializerRegistry()
 
178
format_registry.register_lazy('4', 'bzrlib.xml4', 'serializer_v4')
 
179
format_registry.register_lazy('5', 'bzrlib.xml5', 'serializer_v5')
 
180
format_registry.register_lazy('6', 'bzrlib.xml6', 'serializer_v6')
 
181
format_registry.register_lazy('7', 'bzrlib.xml7', 'serializer_v7')