mimedecode.py

   1 #! /usr/bin/env python
   2 """Decode MIME message"""
   3
   4 from mimedecode_version import __version__, __author__, __copyright__, __license__
   5
   6 import sys, os
   7 import email
   8
   9 me = os.path.basename(sys.argv[0])
  10
  11
  12 def version(exit=1):
  13     sys.stdout.write("""\
  14 Broytman mimedecode.py version %s, %s
  15 """ % (__version__, __copyright__))
  16     if exit: sys.exit(0)
  17
  18 def usage(code=0, errormsg=''):
  19     version(0)
  20     sys.stdout.write("""\
  21 Usage: %s [-h|--help] [-V|--version] [-cCDP] [-H|--host=hostname] [-f charset] [-d header1[,header2,header3...]] [-p header:param] [-r header] [-R header:param] [--remove-params=header] [-beit mask] [-o output_file] [input_file [output_file]]
  22 """ % me)
  23     if errormsg:
  24         sys.stderr.write(errormsg + '\n')
  25     sys.exit(code)
  26
  27
  28 def output_headers(msg):
  29     unix_from = msg.get_unixfrom()
  30     if unix_from:
  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
  35
  36
  37 def recode(s, charset):
  38     return unicode(s, charset, "replace").encode(gopts.default_encoding, "replace")
  39
  40 def recode_if_needed(s, charset):
  41     if charset and charset.lower() <> gopts.default_encoding:
  42         s = recode(s, charset)
  43     return s
  44
  45
  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.
  49     """
  50     import email.Header
  51
  52     L = email.Header.decode_header(s)
  53     if not isinstance(L, list):
  54         # s wasn't decoded
  55         return s
  56
  57     rtn = []
  58     for atom, charset in L:
  59         if charset is None:
  60             rtn.append(atom)
  61         else:
  62             rtn.append(recode_if_needed(atom, charset))
  63         rtn.append(' ')
  64     del rtn[-1] # remove the last space
  65
  66     # Now that we've decoded everything, we just need to join all the parts
  67     # together into the final string.
  68     return ''.join(rtn)
  69
  70 def decode_header(msg, header):
  71     "Decode mail header (if exists) and put it back, if it was encoded"
  72
  73     if msg.has_key(header):
  74         value = msg[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)
  78
  79
  80 def _decode_header_param(s):
  81     return recode_if_needed(s[2], s[0])
  82
  83 def decode_header_param(msg, header, param):
  84     "Decode mail header's parameter (if exists) and put it back, if it was encoded"
  85
  86     if msg.has_key(header):
  87         value = msg.get_param(param, header=header)
  88         if value:
  89             if isinstance(value, tuple):
  90                 new_value = _decode_header_param(value)
  91             else:
  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)
  95
  96
  97 def decode_headers(msg):
  98     "Decode message headers according to global options"
  99
 100     for header in gopts.remove_headers:
 101         del msg[header]
 102
 103     for header in gopts.remove_all_params:
 104         value = msg[header]
 105         if value is None: # No such header
 106             continue
 107         if ';' not in value: # There are no parameters
 108             continue
 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()
 112
 113     for header, param in gopts.remove_header_params:
 114         msg.del_param(param, header)
 115
 116     for header_list in gopts.decode_headers:
 117         for header in header_list.split(','):
 118             decode_header(msg, header)
 119
 120     for header, param in gopts.decode_header_params:
 121         decode_header_param(msg, header, param)
 122
 123
 124 def set_header(msg, header, value):
 125     "Replace header"
 126
 127     if msg.has_key(header):
 128         msg.replace_header(header, value)
 129     else:
 130         msg[header] = value
 131
 132
 133 def set_content_type(msg, newtype, charset=None):
 134     msg.set_type(newtype)
 135
 136     if charset:
 137         msg.set_param("charset", charset, "Content-Type")
 138
 139
 140 caps = None # Globally stored mailcap database; initialized only if needed
 141
 142 def decode_body(msg, s):
 143     "Decode body to plain text using first copiousoutput filter from mailcap"
 144
 145     import mailcap, tempfile
 146
 147     global caps
 148     if caps is None:
 149         caps = mailcap.getcaps()
 150
 151     content_type = msg.get_content_type()
 152     filename = tempfile.mktemp()
 153     command = None
 154
 155     entries = mailcap.lookup(caps, content_type, "view")
 156     for entry in entries:
 157         if entry.has_key('copiousoutput'):
 158             if entry.has_key('test'):
 159                 test = mailcap.subst(entry['test'], content_type, filename)
 160                 if test and os.system(test) != 0:
 161                     continue
 162             command = mailcap.subst(entry["view"], content_type, filename)
 163             break
 164
 165     if not command:
 166         return s
 167
 168     file = open(filename, 'w')
 169     file.write(s)
 170     file.close()
 171
 172     pipe = os.popen(command, 'r')
 173     s = pipe.read()
 174     pipe.close()
 175     os.remove(filename)
 176
 177     set_content_type(msg, "text/plain")
 178     msg["X-MIME-Autoconverted"] = "from %s to text/plain by %s id %s" % (content_type, gopts.host_name, command.split()[0])
 179
 180     return s
 181
 182
 183 def recode_charset(msg, s):
 184     "Recode charset of the message to the default charset"
 185
 186     save_charset = charset = msg.get_content_charset()
 187     if charset and charset.lower() <> gopts.default_encoding:
 188         s = recode_if_needed(s, charset)
 189         content_type = msg.get_content_type()
 190         set_content_type(msg, content_type, gopts.default_encoding)
 191         msg["X-MIME-Autoconverted"] = "from %s to %s by %s id %s" % (save_charset, gopts.default_encoding, gopts.host_name, me)
 192     return s
 193
 194
 195 def totext(msg, instring):
 196     "Convert instring content to text"
 197
 198     # Decode body and recode charset
 199     s = decode_body(msg, instring)
 200     if gopts.recode_charset:
 201         s = recode_charset(msg, s)
 202
 203     output_headers(msg)
 204     output(s)
 205
 206
 207 def decode_part(msg):
 208     "Decode one part of the message"
 209
 210     decode_headers(msg)
 211     encoding = msg["Content-Transfer-Encoding"]
 212
 213     if encoding in (None, '', '7bit', '8bit', 'binary'):
 214         outstring = str(msg.get_payload())
 215     else: # Decode from transfer ecoding to text or binary form
 216         outstring = str(msg.get_payload(decode=1))
 217         set_header(msg, "Content-Transfer-Encoding", "8bit")
 218         msg["X-MIME-Autoconverted"] = "from %s to 8bit by %s id %s" % (encoding, gopts.host_name, me)
 219
 220     # Test all mask lists and find what to do with this content type
 221     masks = []
 222     ctype = msg.get_content_type()
 223     if ctype:
 224         masks.append(ctype)
 225     mtype = msg.get_content_maintype()
 226     if mtype:
 227         masks.append(mtype + '/*')
 228     masks.append('*/*')
 229
 230     for content_type in masks:
 231         if content_type in gopts.totext_mask:
 232             totext(msg, outstring)
 233             return
 234         elif content_type in gopts.binary_mask:
 235             output_headers(msg)
 236             output(outstring)
 237             return
 238         elif content_type in gopts.ignore_mask:
 239             output_headers(msg)
 240             output("\nMessage body of type `%s' skipped.\n" % content_type)
 241             return
 242         elif content_type in gopts.error_mask:
 243             raise ValueError, "content type `%s' prohibited" % content_type
 244
 245     # Neither content type nor masks were listed - decode by default
 246     totext(msg, outstring)
 247
 248
 249 def decode_multipart(msg):
 250     "Decode multipart"
 251
 252     decode_headers(msg)
 253     output_headers(msg)
 254
 255     if msg.preamble: # Preserve the first part, it is probably not a RFC822-message
 256         output(msg.preamble) # Usually it is just a few lines of text (MIME warning)
 257
 258     boundary = msg.get_boundary()
 259
 260     for subpart in msg.get_payload():
 261         if boundary:
 262             output("\n--%s\n" % boundary)
 263
 264         # Recursively decode all parts of the subpart
 265         decode_message(subpart)
 266
 267     if boundary:
 268         output("\n--%s--\n" % boundary)
 269
 270     if msg.epilogue:
 271         output(msg.epilogue)
 272
 273
 274 def decode_message(msg):
 275     "Decode message"
 276
 277     if msg.is_multipart():
 278         decode_multipart(msg)
 279     elif len(msg): # Simple one-part message (there are headers) - decode it
 280         decode_part(msg)
 281     else: # Not a message, just text - copy it literally
 282         output(msg.as_string())
 283
 284
 285 class GlobalOptions:
 286     from m_lib.defenc import default_encoding
 287     recode_charset = 1 # recode charset of message body
 288
 289     host_name = None
 290
 291     # A list of headers to decode
 292     decode_headers = ["From", "To", "Cc", "Reply-To", "Mail-Followup-To",
 293                       "Subject"]
 294
 295     # A list of headers parameters to decode
 296     decode_header_params = [
 297         ("Content-Type", "name"),
 298         ("Content-Disposition", "filename"),
 299     ]
 300
 301     # A list of headers to remove
 302     remove_headers = []
 303     # A list of headers parameters to remove
 304     remove_header_params = []
 305     # A list of headers to be stripped of all parameters
 306     remove_all_params = []
 307
 308     totext_mask = [] # A list of content-types to decode
 309     binary_mask = [] # A list to pass through
 310     ignore_mask = [] # Ignore (skip, do not decode and do not include into output)
 311     error_mask = []  # Raise error if encounter one of these
 312
 313     input_filename = None
 314     output_filename = None
 315
 316 gopts = GlobalOptions
 317
 318
 319 def get_opt():
 320     from getopt import getopt, GetoptError
 321
 322     try:
 323         options, arguments = getopt(sys.argv[1:],
 324             'hVcCDPH:f:d:p:r:R:b:e:i:t:o:',
 325             ['help', 'version', 'host=', 'remove-params='])
 326     except GetoptError:
 327         usage(1)
 328
 329     for option, value in options:
 330         if option in ('-h', '--help'):
 331             usage()
 332         elif option in ('-V', '--version'):
 333             version()
 334         elif option == '-c':
 335             gopts.recode_charset = 1
 336         elif option == '-C':
 337             gopts.recode_charset = 0
 338         elif option in ('-H', '--host'):
 339             gopts.host_name = value
 340         elif option == '-f':
 341             gopts.default_encoding = value
 342         elif option == '-d':
 343             gopts.decode_headers.append(value)
 344         elif option == '-D':
 345             gopts.decode_headers = []
 346         elif option == '-p':
 347             gopts.decode_header_params.append(value.split(':', 1))
 348         elif option == '-P':
 349             gopts.decode_header_params = []
 350         elif option == '-r':
 351             gopts.remove_headers.append(value)
 352         elif option == '-R':
 353             gopts.remove_header_params.append(value.split(':', 1))
 354         elif option == '--remove-params':
 355             gopts.remove_all_params.append(value)
 356         elif option == '-t':
 357             gopts.totext_mask.append(value)
 358         elif option == '-b':
 359             gopts.binary_mask.append(value)
 360         elif option == '-i':
 361             gopts.ignore_mask.append(value)
 362         elif option == '-e':
 363             gopts.error_mask.append(value)
 364         elif option == '-o':
 365             gopts.output_filename = value
 366         else:
 367             usage(1)
 368
 369     return arguments
 370
 371
 372 if __name__ == "__main__":
 373     arguments = get_opt()
 374
 375     la = len(arguments)
 376     if la == 0:
 377         gopts.input_filename = '-'
 378         infile = sys.stdin
 379         if gopts.output_filename:
 380             outfile = open(gopts.output_filename, 'w')
 381         else:
 382             gopts.output_filename = '-'
 383             outfile = sys.stdout
 384     elif la in (1, 2):
 385         if (arguments[0] == '-'):
 386             gopts.input_filename = '-'
 387             infile = sys.stdin
 388         else:
 389             gopts.input_filename = arguments[0]
 390             infile = open(arguments[0], 'r')
 391         if la == 1:
 392             if gopts.output_filename:
 393                 outfile = open(gopts.output_filename, 'w')
 394             else:
 395                 gopts.output_filename = '-'
 396                 outfile = sys.stdout
 397         elif la == 2:
 398             if gopts.output_filename:
 399                 usage(1, 'Too many output filenames')
 400             if (arguments[1] == '-'):
 401                 gopts.output_filename = '-'
 402                 outfile = sys.stdout
 403             else:
 404                 gopts.output_filename = arguments[1]
 405                 outfile = open(arguments[1], 'w')
 406     else:
 407         usage(1, 'Too many arguments')
 408
 409     if (infile is sys.stdin) and sys.stdin.isatty():
 410         if (outfile is sys.stdout) and sys.stdout.isatty():
 411             usage()
 412         usage(1, 'Filtering from console is forbidden')
 413
 414     if not gopts.host_name:
 415         import socket
 416         gopts.host_name = socket.gethostname()
 417
 418     gopts.outfile = outfile
 419     output = outfile.write
 420
 421     try:
 422         decode_message(email.message_from_file(infile))
 423     finally:
 424         infile.close()
 425         outfile.close()