Benjamin Peterson | 46a9900 | 2010-01-09 18:45:30 +0000 | [diff] [blame] | 1 | # Copyright (C) 2001-2010 Python Software Foundation |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 2 | # Author: Barry Warsaw |
| 3 | # Contact: email-sig@python.org |
| 4 | |
| 5 | """Classes to generate plain text from a message object tree.""" |
| 6 | |
R David Murray | 1b6c724 | 2012-03-16 22:43:05 -0400 | [diff] [blame] | 7 | __all__ = ['Generator', 'DecodedGenerator', 'BytesGenerator'] |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 8 | |
| 9 | import re |
| 10 | import sys |
| 11 | import time |
| 12 | import random |
| 13 | import warnings |
| 14 | |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 15 | from io import StringIO, BytesIO |
R David Murray | c27e522 | 2012-05-25 15:01:48 -0400 | [diff] [blame] | 16 | from email._policybase import compat32 |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 17 | from email.header import Header |
R David Murray | c27e522 | 2012-05-25 15:01:48 -0400 | [diff] [blame] | 18 | from email.utils import _has_surrogates |
R David Murray | 3edd22a | 2011-04-18 13:59:37 -0400 | [diff] [blame] | 19 | import email.charset as _charset |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 20 | |
| 21 | UNDERSCORE = '_' |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 22 | NL = '\n' # XXX: no longer used by the code below. |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 23 | |
| 24 | fcre = re.compile(r'^From ', re.MULTILINE) |
| 25 | |
| 26 | |
| 27 | |
| 28 | class Generator: |
| 29 | """Generates output from a Message object tree. |
| 30 | |
| 31 | This basic generator writes the message to the given file object as plain |
| 32 | text. |
| 33 | """ |
| 34 | # |
| 35 | # Public interface |
| 36 | # |
| 37 | |
R David Murray | 3edd22a | 2011-04-18 13:59:37 -0400 | [diff] [blame] | 38 | def __init__(self, outfp, mangle_from_=True, maxheaderlen=None, *, |
R David Murray | c27e522 | 2012-05-25 15:01:48 -0400 | [diff] [blame] | 39 | policy=None): |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 40 | """Create the generator for message flattening. |
| 41 | |
| 42 | outfp is the output file-like object for writing the message to. It |
| 43 | must have a write() method. |
| 44 | |
| 45 | Optional mangle_from_ is a flag that, when True (the default), escapes |
| 46 | From_ lines in the body of the message by putting a `>' in front of |
| 47 | them. |
| 48 | |
| 49 | Optional maxheaderlen specifies the longest length for a non-continued |
| 50 | header. When a header line is longer (in characters, with tabs |
| 51 | expanded to 8 spaces) than maxheaderlen, the header will split as |
| 52 | defined in the Header class. Set maxheaderlen to zero to disable |
| 53 | header wrapping. The default is 78, as recommended (but not required) |
| 54 | by RFC 2822. |
R David Murray | 3edd22a | 2011-04-18 13:59:37 -0400 | [diff] [blame] | 55 | |
| 56 | The policy keyword specifies a policy object that controls a number of |
| 57 | aspects of the generator's operation. The default policy maintains |
| 58 | backward compatibility. |
| 59 | |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 60 | """ |
| 61 | self._fp = outfp |
| 62 | self._mangle_from_ = mangle_from_ |
R David Murray | c27e522 | 2012-05-25 15:01:48 -0400 | [diff] [blame] | 63 | self.maxheaderlen = maxheaderlen |
R David Murray | 3edd22a | 2011-04-18 13:59:37 -0400 | [diff] [blame] | 64 | self.policy = policy |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 65 | |
| 66 | def write(self, s): |
| 67 | # Just delegate to the file object |
| 68 | self._fp.write(s) |
| 69 | |
R David Murray | 3edd22a | 2011-04-18 13:59:37 -0400 | [diff] [blame] | 70 | def flatten(self, msg, unixfrom=False, linesep=None): |
R David Murray | cd37dfc | 2011-03-14 18:35:56 -0400 | [diff] [blame] | 71 | r"""Print the message object tree rooted at msg to the output file |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 72 | specified when the Generator instance was created. |
| 73 | |
| 74 | unixfrom is a flag that forces the printing of a Unix From_ delimiter |
| 75 | before the first object in the message tree. If the original message |
| 76 | has no From_ delimiter, a `standard' one is crafted. By default, this |
| 77 | is False to inhibit the printing of any From_ delimiter. |
| 78 | |
| 79 | Note that for subobjects, no From_ line is printed. |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 80 | |
| 81 | linesep specifies the characters used to indicate a new line in |
R David Murray | 3edd22a | 2011-04-18 13:59:37 -0400 | [diff] [blame] | 82 | the output. The default value is determined by the policy. |
R David Murray | cd37dfc | 2011-03-14 18:35:56 -0400 | [diff] [blame] | 83 | |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 84 | """ |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 85 | # We use the _XXX constants for operating on data that comes directly |
| 86 | # from the msg, and _encoded_XXX constants for operating on data that |
| 87 | # has already been converted (to bytes in the BytesGenerator) and |
| 88 | # inserted into a temporary buffer. |
R David Murray | c27e522 | 2012-05-25 15:01:48 -0400 | [diff] [blame] | 89 | policy = msg.policy if self.policy is None else self.policy |
| 90 | if linesep is not None: |
| 91 | policy = policy.clone(linesep=linesep) |
| 92 | if self.maxheaderlen is not None: |
| 93 | policy = policy.clone(max_line_length=self.maxheaderlen) |
| 94 | self._NL = policy.linesep |
R David Murray | 3edd22a | 2011-04-18 13:59:37 -0400 | [diff] [blame] | 95 | self._encoded_NL = self._encode(self._NL) |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 96 | self._EMPTY = '' |
| 97 | self._encoded_EMTPY = self._encode('') |
R David Murray | 0b6f6c8 | 2012-05-25 18:42:14 -0400 | [diff] [blame^] | 98 | # Because we use clone (below) when we recursively process message |
| 99 | # subparts, and because clone uses the computed policy (not None), |
| 100 | # submessages will automatically get set to the computed policy when |
| 101 | # they are processed by this code. |
| 102 | old_gen_policy = self.policy |
| 103 | old_msg_policy = msg.policy |
R David Murray | c27e522 | 2012-05-25 15:01:48 -0400 | [diff] [blame] | 104 | try: |
| 105 | self.policy = policy |
R David Murray | 0b6f6c8 | 2012-05-25 18:42:14 -0400 | [diff] [blame^] | 106 | msg.policy = policy |
R David Murray | c27e522 | 2012-05-25 15:01:48 -0400 | [diff] [blame] | 107 | if unixfrom: |
| 108 | ufrom = msg.get_unixfrom() |
| 109 | if not ufrom: |
| 110 | ufrom = 'From nobody ' + time.ctime(time.time()) |
| 111 | self.write(ufrom + self._NL) |
| 112 | self._write(msg) |
| 113 | finally: |
R David Murray | 0b6f6c8 | 2012-05-25 18:42:14 -0400 | [diff] [blame^] | 114 | self.policy = old_gen_policy |
| 115 | msg.policy = old_msg_policy |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 116 | |
| 117 | def clone(self, fp): |
| 118 | """Clone this generator with the exact same options.""" |
R David Murray | c27e522 | 2012-05-25 15:01:48 -0400 | [diff] [blame] | 119 | return self.__class__(fp, |
| 120 | self._mangle_from_, |
| 121 | None, # Use policy setting, which we've adjusted |
| 122 | policy=self.policy) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 123 | |
| 124 | # |
| 125 | # Protected interface - undocumented ;/ |
| 126 | # |
| 127 | |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 128 | # Note that we use 'self.write' when what we are writing is coming from |
| 129 | # the source, and self._fp.write when what we are writing is coming from a |
| 130 | # buffer (because the Bytes subclass has already had a chance to transform |
| 131 | # the data in its write method in that case). This is an entirely |
| 132 | # pragmatic split determined by experiment; we could be more general by |
| 133 | # always using write and having the Bytes subclass write method detect when |
| 134 | # it has already transformed the input; but, since this whole thing is a |
| 135 | # hack anyway this seems good enough. |
| 136 | |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 137 | # Similarly, we have _XXX and _encoded_XXX attributes that are used on |
| 138 | # source and buffer data, respectively. |
| 139 | _encoded_EMPTY = '' |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 140 | |
| 141 | def _new_buffer(self): |
| 142 | # BytesGenerator overrides this to return BytesIO. |
| 143 | return StringIO() |
| 144 | |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 145 | def _encode(self, s): |
| 146 | # BytesGenerator overrides this to encode strings to bytes. |
| 147 | return s |
| 148 | |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 149 | def _write(self, msg): |
| 150 | # We can't write the headers yet because of the following scenario: |
| 151 | # say a multipart message includes the boundary string somewhere in |
| 152 | # its body. We'd have to calculate the new boundary /before/ we write |
| 153 | # the headers so that we can write the correct Content-Type: |
| 154 | # parameter. |
| 155 | # |
| 156 | # The way we do this, so as to make the _handle_*() methods simpler, |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 157 | # is to cache any subpart writes into a buffer. The we write the |
| 158 | # headers and the buffer contents. That way, subpart handlers can |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 159 | # Do The Right Thing, and can still modify the Content-Type: header if |
| 160 | # necessary. |
| 161 | oldfp = self._fp |
| 162 | try: |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 163 | self._fp = sfp = self._new_buffer() |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 164 | self._dispatch(msg) |
| 165 | finally: |
| 166 | self._fp = oldfp |
| 167 | # Write the headers. First we see if the message object wants to |
| 168 | # handle that itself. If not, we'll do it generically. |
| 169 | meth = getattr(msg, '_write_headers', None) |
| 170 | if meth is None: |
| 171 | self._write_headers(msg) |
| 172 | else: |
| 173 | meth(self) |
| 174 | self._fp.write(sfp.getvalue()) |
| 175 | |
| 176 | def _dispatch(self, msg): |
| 177 | # Get the Content-Type: for the message, then try to dispatch to |
| 178 | # self._handle_<maintype>_<subtype>(). If there's no handler for the |
| 179 | # full MIME type, then dispatch to self._handle_<maintype>(). If |
| 180 | # that's missing too, then dispatch to self._writeBody(). |
| 181 | main = msg.get_content_maintype() |
| 182 | sub = msg.get_content_subtype() |
| 183 | specific = UNDERSCORE.join((main, sub)).replace('-', '_') |
| 184 | meth = getattr(self, '_handle_' + specific, None) |
| 185 | if meth is None: |
| 186 | generic = main.replace('-', '_') |
| 187 | meth = getattr(self, '_handle_' + generic, None) |
| 188 | if meth is None: |
| 189 | meth = self._writeBody |
| 190 | meth(msg) |
| 191 | |
| 192 | # |
| 193 | # Default handlers |
| 194 | # |
| 195 | |
| 196 | def _write_headers(self, msg): |
R David Murray | c27e522 | 2012-05-25 15:01:48 -0400 | [diff] [blame] | 197 | for h, v in msg.raw_items(): |
| 198 | self.write(self.policy.fold(h, v)) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 199 | # A blank line always separates headers from body |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 200 | self.write(self._NL) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 201 | |
| 202 | # |
| 203 | # Handlers for writing types and subtypes |
| 204 | # |
| 205 | |
| 206 | def _handle_text(self, msg): |
| 207 | payload = msg.get_payload() |
| 208 | if payload is None: |
| 209 | return |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 210 | if not isinstance(payload, str): |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 211 | raise TypeError('string payload expected: %s' % type(payload)) |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 212 | if _has_surrogates(msg._payload): |
| 213 | charset = msg.get_param('charset') |
| 214 | if charset is not None: |
| 215 | del msg['content-transfer-encoding'] |
| 216 | msg.set_payload(payload, charset) |
| 217 | payload = msg.get_payload() |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 218 | if self._mangle_from_: |
| 219 | payload = fcre.sub('>From ', payload) |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 220 | self.write(payload) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 221 | |
| 222 | # Default body handler |
| 223 | _writeBody = _handle_text |
| 224 | |
| 225 | def _handle_multipart(self, msg): |
| 226 | # The trick here is to write out each part separately, merge them all |
| 227 | # together, and then make sure that the boundary we've chosen isn't |
| 228 | # present in the payload. |
| 229 | msgtexts = [] |
| 230 | subparts = msg.get_payload() |
| 231 | if subparts is None: |
| 232 | subparts = [] |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 233 | elif isinstance(subparts, str): |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 234 | # e.g. a non-strict parse of a message with no starting boundary. |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 235 | self.write(subparts) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 236 | return |
| 237 | elif not isinstance(subparts, list): |
| 238 | # Scalar payload |
| 239 | subparts = [subparts] |
| 240 | for part in subparts: |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 241 | s = self._new_buffer() |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 242 | g = self.clone(s) |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 243 | g.flatten(part, unixfrom=False, linesep=self._NL) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 244 | msgtexts.append(s.getvalue()) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 245 | # BAW: What about boundaries that are wrapped in double-quotes? |
R. David Murray | 5260a9b | 2010-12-12 20:06:19 +0000 | [diff] [blame] | 246 | boundary = msg.get_boundary() |
| 247 | if not boundary: |
| 248 | # Create a boundary that doesn't appear in any of the |
| 249 | # message texts. |
| 250 | alltext = self._encoded_NL.join(msgtexts) |
R. David Murray | 73a559d | 2010-12-21 18:07:59 +0000 | [diff] [blame] | 251 | boundary = self._make_boundary(alltext) |
| 252 | msg.set_boundary(boundary) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 253 | # If there's a preamble, write it out, with a trailing CRLF |
| 254 | if msg.preamble is not None: |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 255 | self.write(msg.preamble + self._NL) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 256 | # dash-boundary transport-padding CRLF |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 257 | self.write('--' + boundary + self._NL) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 258 | # body-part |
| 259 | if msgtexts: |
| 260 | self._fp.write(msgtexts.pop(0)) |
| 261 | # *encapsulation |
| 262 | # --> delimiter transport-padding |
| 263 | # --> CRLF body-part |
| 264 | for body_part in msgtexts: |
| 265 | # delimiter transport-padding CRLF |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 266 | self.write(self._NL + '--' + boundary + self._NL) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 267 | # body-part |
| 268 | self._fp.write(body_part) |
| 269 | # close-delimiter transport-padding |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 270 | self.write(self._NL + '--' + boundary + '--') |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 271 | if msg.epilogue is not None: |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 272 | self.write(self._NL) |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 273 | self.write(msg.epilogue) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 274 | |
R. David Murray | a8f480f | 2010-01-16 18:30:03 +0000 | [diff] [blame] | 275 | def _handle_multipart_signed(self, msg): |
| 276 | # The contents of signed parts has to stay unmodified in order to keep |
| 277 | # the signature intact per RFC1847 2.1, so we disable header wrapping. |
| 278 | # RDM: This isn't enough to completely preserve the part, but it helps. |
R David Murray | c27e522 | 2012-05-25 15:01:48 -0400 | [diff] [blame] | 279 | p = self.policy |
| 280 | self.policy = p.clone(max_line_length=0) |
R. David Murray | a8f480f | 2010-01-16 18:30:03 +0000 | [diff] [blame] | 281 | try: |
R. David Murray | a8f480f | 2010-01-16 18:30:03 +0000 | [diff] [blame] | 282 | self._handle_multipart(msg) |
| 283 | finally: |
R David Murray | c27e522 | 2012-05-25 15:01:48 -0400 | [diff] [blame] | 284 | self.policy = p |
R. David Murray | a8f480f | 2010-01-16 18:30:03 +0000 | [diff] [blame] | 285 | |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 286 | def _handle_message_delivery_status(self, msg): |
| 287 | # We can't just write the headers directly to self's file object |
| 288 | # because this will leave an extra newline between the last header |
| 289 | # block and the boundary. Sigh. |
| 290 | blocks = [] |
| 291 | for part in msg.get_payload(): |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 292 | s = self._new_buffer() |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 293 | g = self.clone(s) |
R. David Murray | 719a449 | 2010-11-21 16:53:48 +0000 | [diff] [blame] | 294 | g.flatten(part, unixfrom=False, linesep=self._NL) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 295 | text = s.getvalue() |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 296 | lines = text.split(self._encoded_NL) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 297 | # Strip off the unnecessary trailing empty line |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 298 | if lines and lines[-1] == self._encoded_EMPTY: |
| 299 | blocks.append(self._encoded_NL.join(lines[:-1])) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 300 | else: |
| 301 | blocks.append(text) |
| 302 | # Now join all the blocks with an empty line. This has the lovely |
| 303 | # effect of separating each block with an empty line, but not adding |
| 304 | # an extra one after the last one. |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 305 | self._fp.write(self._encoded_NL.join(blocks)) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 306 | |
| 307 | def _handle_message(self, msg): |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 308 | s = self._new_buffer() |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 309 | g = self.clone(s) |
| 310 | # The payload of a message/rfc822 part should be a multipart sequence |
| 311 | # of length 1. The zeroth element of the list should be the Message |
| 312 | # object for the subpart. Extract that object, stringify it, and |
| 313 | # write it out. |
R. David Murray | 57c45ac | 2010-02-21 04:39:40 +0000 | [diff] [blame] | 314 | # Except, it turns out, when it's a string instead, which happens when |
| 315 | # and only when HeaderParser is used on a message of mime type |
| 316 | # message/rfc822. Such messages are generated by, for example, |
| 317 | # Groupwise when forwarding unadorned messages. (Issue 7970.) So |
| 318 | # in that case we just emit the string body. |
R David Murray | b35c850 | 2011-04-13 16:46:05 -0400 | [diff] [blame] | 319 | payload = msg._payload |
R. David Murray | 57c45ac | 2010-02-21 04:39:40 +0000 | [diff] [blame] | 320 | if isinstance(payload, list): |
R. David Murray | 719a449 | 2010-11-21 16:53:48 +0000 | [diff] [blame] | 321 | g.flatten(msg.get_payload(0), unixfrom=False, linesep=self._NL) |
R. David Murray | 57c45ac | 2010-02-21 04:39:40 +0000 | [diff] [blame] | 322 | payload = s.getvalue() |
R David Murray | b35c850 | 2011-04-13 16:46:05 -0400 | [diff] [blame] | 323 | else: |
| 324 | payload = self._encode(payload) |
R. David Murray | 57c45ac | 2010-02-21 04:39:40 +0000 | [diff] [blame] | 325 | self._fp.write(payload) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 326 | |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 327 | # This used to be a module level function; we use a classmethod for this |
| 328 | # and _compile_re so we can continue to provide the module level function |
| 329 | # for backward compatibility by doing |
| 330 | # _make_boudary = Generator._make_boundary |
| 331 | # at the end of the module. It *is* internal, so we could drop that... |
| 332 | @classmethod |
| 333 | def _make_boundary(cls, text=None): |
| 334 | # Craft a random boundary. If text is given, ensure that the chosen |
| 335 | # boundary doesn't appear in the text. |
| 336 | token = random.randrange(sys.maxsize) |
| 337 | boundary = ('=' * 15) + (_fmt % token) + '==' |
| 338 | if text is None: |
| 339 | return boundary |
| 340 | b = boundary |
| 341 | counter = 0 |
| 342 | while True: |
| 343 | cre = cls._compile_re('^--' + re.escape(b) + '(--)?$', re.MULTILINE) |
| 344 | if not cre.search(text): |
| 345 | break |
| 346 | b = boundary + '.' + str(counter) |
| 347 | counter += 1 |
| 348 | return b |
| 349 | |
| 350 | @classmethod |
| 351 | def _compile_re(cls, s, flags): |
| 352 | return re.compile(s, flags) |
| 353 | |
| 354 | |
| 355 | class BytesGenerator(Generator): |
| 356 | """Generates a bytes version of a Message object tree. |
| 357 | |
| 358 | Functionally identical to the base Generator except that the output is |
| 359 | bytes and not string. When surrogates were used in the input to encode |
R David Murray | 3edd22a | 2011-04-18 13:59:37 -0400 | [diff] [blame] | 360 | bytes, these are decoded back to bytes for output. If the policy has |
R David Murray | c27e522 | 2012-05-25 15:01:48 -0400 | [diff] [blame] | 361 | cte_type set to 7bit, then the message is transformed such that the |
| 362 | non-ASCII bytes are properly content transfer encoded, using the charset |
| 363 | unknown-8bit. |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 364 | |
| 365 | The outfp object must accept bytes in its write method. |
| 366 | """ |
| 367 | |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 368 | # Bytes versions of this constant for use in manipulating data from |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 369 | # the BytesIO buffer. |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 370 | _encoded_EMPTY = b'' |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 371 | |
| 372 | def write(self, s): |
| 373 | self._fp.write(s.encode('ascii', 'surrogateescape')) |
| 374 | |
| 375 | def _new_buffer(self): |
| 376 | return BytesIO() |
| 377 | |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 378 | def _encode(self, s): |
| 379 | return s.encode('ascii') |
| 380 | |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 381 | def _write_headers(self, msg): |
| 382 | # This is almost the same as the string version, except for handling |
| 383 | # strings with 8bit bytes. |
R David Murray | c27e522 | 2012-05-25 15:01:48 -0400 | [diff] [blame] | 384 | for h, v in msg.raw_items(): |
| 385 | self._fp.write(self.policy.fold_binary(h, v)) |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 386 | # A blank line always separates headers from body |
R. David Murray | 8451c4b | 2010-10-23 22:19:56 +0000 | [diff] [blame] | 387 | self.write(self._NL) |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 388 | |
| 389 | def _handle_text(self, msg): |
| 390 | # If the string has surrogates the original source was bytes, so |
| 391 | # just write it back out. |
R. David Murray | 7372a07 | 2011-01-26 21:21:32 +0000 | [diff] [blame] | 392 | if msg._payload is None: |
| 393 | return |
R David Murray | c27e522 | 2012-05-25 15:01:48 -0400 | [diff] [blame] | 394 | if _has_surrogates(msg._payload) and not self.policy.cte_type=='7bit': |
R. David Murray | bdd2d93 | 2011-01-26 02:31:37 +0000 | [diff] [blame] | 395 | self.write(msg._payload) |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 396 | else: |
| 397 | super(BytesGenerator,self)._handle_text(msg) |
| 398 | |
| 399 | @classmethod |
| 400 | def _compile_re(cls, s, flags): |
| 401 | return re.compile(s.encode('ascii'), flags) |
| 402 | |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 403 | |
| 404 | |
| 405 | _FMT = '[Non-text (%(type)s) part of message omitted, filename %(filename)s]' |
| 406 | |
| 407 | class DecodedGenerator(Generator): |
R. David Murray | 70a9993 | 2010-10-01 20:38:33 +0000 | [diff] [blame] | 408 | """Generates a text representation of a message. |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 409 | |
| 410 | Like the Generator base class, except that non-text parts are substituted |
| 411 | with a format string representing the part. |
| 412 | """ |
| 413 | def __init__(self, outfp, mangle_from_=True, maxheaderlen=78, fmt=None): |
| 414 | """Like Generator.__init__() except that an additional optional |
| 415 | argument is allowed. |
| 416 | |
| 417 | Walks through all subparts of a message. If the subpart is of main |
| 418 | type `text', then it prints the decoded payload of the subpart. |
| 419 | |
| 420 | Otherwise, fmt is a format string that is used instead of the message |
| 421 | payload. fmt is expanded with the following keywords (in |
| 422 | %(keyword)s format): |
| 423 | |
| 424 | type : Full MIME type of the non-text part |
| 425 | maintype : Main MIME type of the non-text part |
| 426 | subtype : Sub-MIME type of the non-text part |
| 427 | filename : Filename of the non-text part |
| 428 | description: Description associated with the non-text part |
| 429 | encoding : Content transfer encoding of the non-text part |
| 430 | |
| 431 | The default value for fmt is None, meaning |
| 432 | |
| 433 | [Non-text (%(type)s) part of message omitted, filename %(filename)s] |
| 434 | """ |
| 435 | Generator.__init__(self, outfp, mangle_from_, maxheaderlen) |
| 436 | if fmt is None: |
| 437 | self._fmt = _FMT |
| 438 | else: |
| 439 | self._fmt = fmt |
| 440 | |
| 441 | def _dispatch(self, msg): |
| 442 | for part in msg.walk(): |
| 443 | maintype = part.get_content_maintype() |
| 444 | if maintype == 'text': |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 445 | print(part.get_payload(decode=False), file=self) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 446 | elif maintype == 'multipart': |
| 447 | # Just skip this |
| 448 | pass |
| 449 | else: |
| 450 | print(self._fmt % { |
| 451 | 'type' : part.get_content_type(), |
| 452 | 'maintype' : part.get_content_maintype(), |
| 453 | 'subtype' : part.get_content_subtype(), |
| 454 | 'filename' : part.get_filename('[no filename]'), |
| 455 | 'description': part.get('Content-Description', |
| 456 | '[no description]'), |
| 457 | 'encoding' : part.get('Content-Transfer-Encoding', |
| 458 | '[no encoding]'), |
| 459 | }, file=self) |
| 460 | |
| 461 | |
| 462 | |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 463 | # Helper used by Generator._make_boundary |
Christian Heimes | a37d4c6 | 2007-12-04 23:02:19 +0000 | [diff] [blame] | 464 | _width = len(repr(sys.maxsize-1)) |
Guido van Rossum | 8b3febe | 2007-08-30 01:15:14 +0000 | [diff] [blame] | 465 | _fmt = '%%0%dd' % _width |
| 466 | |
R. David Murray | 96fd54e | 2010-10-08 15:55:28 +0000 | [diff] [blame] | 467 | # Backward compatibility |
| 468 | _make_boundary = Generator._make_boundary |