2 """Decode MIME message"""
4 from mimedecode_version import __version__, __author__, __copyright__, __license__
9 me = os.path.basename(sys.argv[0])
14 Broytman mimedecode.py version %s, %s
15 """ % (__version__, __copyright__))
18 def usage(code=0, errormsg=''):
21 Usage: %s [-h|--help] [-V|--version] [-cCDP] [-H|--host=hostname] [-f charset] [-d header] [-p header:param] [-r header] [-R header:param] [--remove-params=header] [-beit mask] [-o output_file] [input_file [output_file]]
24 sys.stderr.write(errormsg + '\n')
28 def output_headers(msg):
29 unix_from = msg.get_unixfrom()
31 output(unix_from + '\n')
32 for key, value in msg.items():
33 output("%s: %s\n" % (key, value))
34 output("\n") # End of headers
37 def recode(s, charset):
38 return unicode(s, charset, "replace").encode(gopts.default_encoding, "replace")
40 def recode_if_needed(s, charset):
41 if charset and charset.lower() <> gopts.default_encoding:
42 s = recode(s, charset)
46 def _decode_header(s):
47 """Return a decoded string according to RFC 2047.
48 NOTE: This is almost the same as email.Utils.decode.
52 L = email.Header.decode_header(s)
53 if not isinstance(L, list):
58 for atom, charset in L:
62 rtn.append(recode_if_needed(atom, charset))
64 del rtn[-1] # remove the last space
66 # Now that we've decoded everything, we just need to join all the parts
67 # together into the final string.
70 def decode_header(msg, header):
71 "Decode mail header (if exists) and put it back, if it was encoded"
73 if msg.has_key(header):
75 new_value = _decode_header(value)
76 if new_value <> value: # do not bother to touch msg if not changed
77 set_header(msg, header, new_value)
80 def _decode_header_param(s):
81 return recode_if_needed(s[2], s[0])
83 def decode_header_param(msg, header, param):
84 "Decode mail header's parameter (if exists) and put it back, if it was encoded"
86 if msg.has_key(header):
87 value = msg.get_param(param, header=header)
89 if isinstance(value, tuple):
90 new_value = _decode_header_param(value)
92 new_value = _decode_header(value)
93 if new_value <> value: # do not bother to touch msg if not changed
94 msg.set_param(param, new_value, header)
97 def decode_headers(msg):
98 "Decode message headers according to global options"
100 for header in gopts.remove_headers:
103 for header in gopts.remove_all_params:
105 if value is None: # No such header
107 if ';' not in value: # There are no parameters
109 del msg[header] # Delete all such headers
110 # Get the value without parameters and set it back
111 msg[header] = value.split(';')[0].strip()
113 for header, param in gopts.remove_header_params:
114 msg.del_param(param, header)
116 for header in gopts.decode_headers:
117 decode_header(msg, header)
119 for header, param in gopts.decode_header_params:
120 decode_header_param(msg, header, param)
123 def set_header(msg, header, value):
126 if msg.has_key(header):
127 msg.replace_header(header, value)
132 def set_content_type(msg, newtype, charset=None):
133 msg.set_type(newtype)
136 msg.set_param("charset", charset, "Content-Type")
139 caps = None # Globally stored mailcap database; initialized only if needed
141 def decode_body(msg, s):
142 "Decode body to plain text using first copiousoutput filter from mailcap"
144 import mailcap, tempfile
148 caps = mailcap.getcaps()
150 content_type = msg.get_content_type()
151 filename = tempfile.mktemp()
154 entries = mailcap.lookup(caps, content_type, "view")
155 for entry in entries:
156 if entry.has_key('copiousoutput'):
157 if entry.has_key('test'):
158 test = mailcap.subst(entry['test'], content_type, filename)
159 if test and os.system(test) != 0:
161 command = mailcap.subst(entry["view"], content_type, filename)
167 file = open(filename, 'w')
171 pipe = os.popen(command, 'r')
176 set_content_type(msg, "text/plain")
177 msg["X-MIME-Autoconverted"] = "from %s to text/plain by %s id %s" % (content_type, gopts.host_name, command.split()[0])
182 def recode_charset(msg, s):
183 "Recode charset of the message to the default charset"
185 save_charset = charset = msg.get_content_charset()
186 if charset and charset.lower() <> gopts.default_encoding:
187 s = recode_if_needed(s, charset)
188 content_type = msg.get_content_type()
189 set_content_type(msg, content_type, gopts.default_encoding)
190 msg["X-MIME-Autoconverted"] = "from %s to %s by %s id %s" % (save_charset, gopts.default_encoding, gopts.host_name, me)
194 def totext(msg, instring):
195 "Convert instring content to text"
197 # Decode body and recode charset
198 s = decode_body(msg, instring)
199 if gopts.recode_charset:
200 s = recode_charset(msg, s)
206 def decode_part(msg):
207 "Decode one part of the message"
210 encoding = msg["Content-Transfer-Encoding"]
212 if encoding in (None, '', '7bit', '8bit', 'binary'):
213 outstring = str(msg.get_payload())
214 else: # Decode from transfer ecoding to text or binary form
215 outstring = str(msg.get_payload(decode=1))
216 set_header(msg, "Content-Transfer-Encoding", "8bit")
217 msg["X-MIME-Autoconverted"] = "from %s to 8bit by %s id %s" % (encoding, gopts.host_name, me)
219 # Test all mask lists and find what to do with this content type
221 ctype = msg.get_content_type()
224 mtype = msg.get_content_maintype()
226 masks.append(mtype + '/*')
229 for content_type in masks:
230 if content_type in gopts.totext_mask:
231 totext(msg, outstring)
233 elif content_type in gopts.binary_mask:
237 elif content_type in gopts.ignore_mask:
239 output("\nMessage body of type `%s' skipped.\n" % content_type)
241 elif content_type in gopts.error_mask:
242 raise ValueError, "content type `%s' prohibited" % content_type
244 # Neither content type nor masks were listed - decode by default
245 totext(msg, outstring)
248 def decode_multipart(msg):
254 if msg.preamble: # Preserve the first part, it is probably not a RFC822-message
255 output(msg.preamble) # Usually it is just a few lines of text (MIME warning)
257 boundary = msg.get_boundary()
259 for subpart in msg.get_payload():
261 output("\n--%s\n" % boundary)
263 # Recursively decode all parts of the subpart
264 decode_message(subpart)
267 output("\n--%s--\n" % boundary)
273 def decode_message(msg):
276 if msg.is_multipart():
277 decode_multipart(msg)
278 elif len(msg): # Simple one-part message (there are headers) - decode it
280 else: # Not a message, just text - copy it literally
281 output(msg.as_string())
285 from m_lib.defenc import default_encoding
286 recode_charset = 1 # recode charset of message body
290 # A list of headers to decode
291 decode_headers = ["From", "To", "Cc", "Reply-To", "Mail-Followup-To",
294 # A list of headers parameters to decode
295 decode_header_params = [
296 ("Content-Type", "name"),
297 ("Content-Disposition", "filename"),
300 # A list of headers to remove
302 # A list of headers parameters to remove
303 remove_header_params = []
304 # A list of headers to be stripped of all parameters
305 remove_all_params = []
307 totext_mask = [] # A list of content-types to decode
308 binary_mask = [] # A list to pass through
309 ignore_mask = [] # Ignore (skip, do not decode and do not include into output)
310 error_mask = [] # Raise error if encounter one of these
312 input_filename = None
313 output_filename = None
315 gopts = GlobalOptions
319 from getopt import getopt, GetoptError
322 options, arguments = getopt(sys.argv[1:],
323 'hVcCDPH:f:d:p:r:R:b:e:i:t:o:',
324 ['help', 'version', 'host=', 'remove-params='])
328 for option, value in options:
329 if option in ('-h', '--help'):
331 elif option in ('-V', '--version'):
334 gopts.recode_charset = 1
336 gopts.recode_charset = 0
337 elif option in ('-H', '--host'):
338 gopts.host_name = value
340 gopts.default_encoding = value
342 gopts.decode_headers.append(value)
344 gopts.decode_headers = []
346 gopts.decode_header_params.append(value.split(':', 1))
348 gopts.decode_header_params = []
350 gopts.remove_headers.append(value)
352 gopts.remove_header_params.append(value.split(':', 1))
353 elif option == '--remove-params':
354 gopts.remove_all_params.append(value)
356 gopts.totext_mask.append(value)
358 gopts.binary_mask.append(value)
360 gopts.ignore_mask.append(value)
362 gopts.error_mask.append(value)
364 gopts.output_filename = value
371 if __name__ == "__main__":
372 arguments = get_opt()
376 gopts.input_filename = '-'
378 if gopts.output_filename:
379 outfile = open(gopts.output_filename, 'w')
381 gopts.output_filename = '-'
384 if (arguments[0] == '-'):
385 gopts.input_filename = '-'
388 gopts.input_filename = arguments[0]
389 infile = open(arguments[0], 'r')
391 if gopts.output_filename:
392 outfile = open(gopts.output_filename, 'w')
394 gopts.output_filename = '-'
397 if gopts.output_filename:
398 usage(1, 'Too many output filenames')
399 if (arguments[1] == '-'):
400 gopts.output_filename = '-'
403 gopts.output_filename = arguments[1]
404 outfile = open(arguments[1], 'w')
406 usage(1, 'Too many arguments')
408 if (infile is sys.stdin) and sys.stdin.isatty():
409 if (outfile is sys.stdout) and sys.stdout.isatty():
411 usage(1, 'Filtering from console is forbidden')
413 if not gopts.host_name:
415 gopts.host_name = socket.gethostname()
417 gopts.outfile = outfile
418 output = outfile.write
421 decode_message(email.message_from_file(infile))