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 header] [-p header:param] [-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.decode_headers:
 101         decode_header(msg, header)
 102
 103     for header, param in gopts.decode_header_params:
 104         decode_header_param(msg, header, param)
 105
 106
 107 def set_header(msg, header, value):
 108     "Replace header"
 109
 110     if msg.has_key(header):
 111         msg.replace_header(header, value)
 112     else:
 113         msg[header] = value
 114
 115
 116 def set_content_type(msg, newtype, charset=None):
 117     msg.set_type(newtype)
 118
 119     if charset:
 120         msg.set_param("charset", charset, "Content-Type")
 121
 122
 123 caps = None # Globally stored mailcap database; initialized only if needed
 124
 125 def decode_body(msg, s):
 126     "Decode body to plain text using first copiousoutput filter from mailcap"
 127
 128     import mailcap, tempfile
 129
 130     global caps
 131     if caps is None:
 132         caps = mailcap.getcaps()
 133
 134     content_type = msg.get_content_type()
 135     filename = tempfile.mktemp()
 136     command = None
 137
 138     entries = mailcap.lookup(caps, content_type, "view")
 139     for entry in entries:
 140         if entry.has_key('copiousoutput'):
 141             if entry.has_key('test'):
 142                 test = mailcap.subst(entry['test'], content_type, filename)
 143                 if test and os.system(test) != 0:
 144                     continue
 145             command = mailcap.subst(entry["view"], content_type, filename)
 146             break
 147
 148     if not command:
 149         return s
 150
 151     file = open(filename, 'w')
 152     file.write(s)
 153     file.close()
 154
 155     pipe = os.popen(command, 'r')
 156     s = pipe.read()
 157     pipe.close()
 158     os.remove(filename)
 159
 160     set_content_type(msg, "text/plain")
 161     msg["X-MIME-Autoconverted"] = "from %s to text/plain by %s id %s" % (content_type, gopts.host_name, command.split()[0])
 162
 163     return s
 164
 165
 166 def recode_charset(msg, s):
 167     "Recode charset of the message to the default charset"
 168
 169     save_charset = charset = msg.get_content_charset()
 170     if charset and charset.lower() <> gopts.default_encoding:
 171         s = recode_if_needed(s, charset)
 172         content_type = msg.get_content_type()
 173         set_content_type(msg, content_type, gopts.default_encoding)
 174         msg["X-MIME-Autoconverted"] = "from %s to %s by %s id %s" % (save_charset, gopts.default_encoding, gopts.host_name, me)
 175     return s
 176
 177
 178 def totext(msg, instring):
 179     "Convert instring content to text"
 180
 181     # Decode body and recode charset
 182     s = decode_body(msg, instring)
 183     if gopts.recode_charset:
 184         s = recode_charset(msg, s)
 185
 186     output_headers(msg)
 187     output(s)
 188
 189
 190 def decode_part(msg):
 191     "Decode one part of the message"
 192
 193     decode_headers(msg)
 194     encoding = msg["Content-Transfer-Encoding"]
 195
 196     if encoding in (None, '', '7bit', '8bit', 'binary'):
 197         outstring = str(msg.get_payload())
 198     else: # Decode from transfer ecoding to text or binary form
 199         outstring = str(msg.get_payload(decode=1))
 200         set_header(msg, "Content-Transfer-Encoding", "8bit")
 201         msg["X-MIME-Autoconverted"] = "from %s to 8bit by %s id %s" % (encoding, gopts.host_name, me)
 202
 203     # Test all mask lists and find what to do with this content type
 204     masks = []
 205     ctype = msg.get_content_type()
 206     if ctype:
 207         masks.append(ctype)
 208     mtype = msg.get_content_maintype()
 209     if mtype:
 210         masks.append(mtype + '/*')
 211     masks.append('*/*')
 212
 213     for content_type in masks:
 214         if content_type in gopts.totext_mask:
 215             totext(msg, outstring)
 216             return
 217         elif content_type in gopts.binary_mask:
 218             output_headers(msg)
 219             output(outstring)
 220             return
 221         elif content_type in gopts.ignore_mask:
 222             output_headers(msg)
 223             output("\nMessage body of type `%s' skipped.\n" % content_type)
 224             return
 225         elif content_type in gopts.error_mask:
 226             raise ValueError, "content type `%s' prohibited" % content_type
 227
 228     # Neither content type nor masks were listed - decode by default
 229     totext(msg, outstring)
 230
 231
 232 def decode_multipart(msg):
 233     "Decode multipart"
 234
 235     decode_headers(msg)
 236     output_headers(msg)
 237
 238     if msg.preamble: # Preserve the first part, it is probably not a RFC822-message
 239         output(msg.preamble) # Usually it is just a few lines of text (MIME warning)
 240
 241     boundary = msg.get_boundary()
 242
 243     for subpart in msg.get_payload():
 244         if boundary:
 245             output("\n--%s\n" % boundary)
 246
 247         # Recursively decode all parts of the subpart
 248         decode_message(subpart)
 249
 250     if boundary:
 251         output("\n--%s--\n" % boundary)
 252
 253     if msg.epilogue:
 254         output(msg.epilogue)
 255
 256
 257 def decode_message(msg):
 258     "Decode message"
 259
 260     if msg.is_multipart():
 261         decode_multipart(msg)
 262     elif len(msg): # Simple one-part message (there are headers) - decode it
 263         decode_part(msg)
 264     else: # Not a message, just text - copy it literally
 265         output(msg.as_string())
 266
 267
 268 class GlobalOptions:
 269     from m_lib.defenc import default_encoding
 270     recode_charset = 1 # recode charset of message body
 271
 272     host_name = None
 273
 274     # A list of headers to decode
 275     decode_headers = ["From", "To", "Cc", "Reply-To", "Mail-Followup-To",
 276                       "Subject"]
 277
 278     # A list of headers' parameters to decode
 279     decode_header_params = [
 280         ("Content-Type", "name"),
 281         ("Content-Disposition", "filename"),
 282     ]
 283
 284     totext_mask = [] # A list of content-types to decode
 285     binary_mask = [] # A list to pass through
 286     ignore_mask = [] # Ignore (skip, do not decode and do not include into output)
 287     error_mask = []  # Raise error if encounter one of these
 288
 289     input_filename = None
 290     output_filename = None
 291
 292 gopts = GlobalOptions
 293
 294
 295 def get_opt():
 296     from getopt import getopt, GetoptError
 297
 298     try:
 299         options, arguments = getopt(sys.argv[1:], 'hVcCDPH:f:d:p:b:e:i:t:o:',
 300             ['help', 'version', 'host'])
 301     except GetoptError:
 302         usage(1)
 303
 304     for option, value in options:
 305         if option in ('-h', '--help'):
 306             usage()
 307         elif option in ('-V', '--version'):
 308             version()
 309         elif option == '-c':
 310             gopts.recode_charset = 1
 311         elif option == '-C':
 312             gopts.recode_charset = 0
 313         elif option in ('-H', '--host'):
 314             gopts.host_name = value
 315         elif option == '-f':
 316             gopts.default_encoding = value
 317         elif option == '-d':
 318             gopts.decode_headers.append(value)
 319         elif option == '-D':
 320             gopts.decode_headers = []
 321         elif option == '-p':
 322             gopts.decode_header_params.append(value.split(':', 1))
 323         elif option == '-P':
 324             gopts.decode_header_params = []
 325         elif option == '-t':
 326             gopts.totext_mask.append(value)
 327         elif option == '-b':
 328             gopts.binary_mask.append(value)
 329         elif option == '-i':
 330             gopts.ignore_mask.append(value)
 331         elif option == '-e':
 332             gopts.error_mask.append(value)
 333         elif option == '-o':
 334             gopts.output_filename = value
 335         else:
 336             usage(1)
 337
 338     return arguments
 339
 340
 341 if __name__ == "__main__":
 342     arguments = get_opt()
 343
 344     la = len(arguments)
 345     if la == 0:
 346         gopts.input_filename = '-'
 347         infile = sys.stdin
 348         if gopts.output_filename:
 349             outfile = open(gopts.output_filename, 'w')
 350         else:
 351             gopts.output_filename = '-'
 352             outfile = sys.stdout
 353     elif la in (1, 2):
 354         if (arguments[0] == '-'):
 355             gopts.input_filename = '-'
 356             infile = sys.stdin
 357         else:
 358             gopts.input_filename = arguments[0]
 359             infile = open(arguments[0], 'r')
 360         if la == 1:
 361             if gopts.output_filename:
 362                 outfile = open(gopts.output_filename, 'w')
 363             else:
 364                 gopts.output_filename = '-'
 365                 outfile = sys.stdout
 366         elif la == 2:
 367             if gopts.output_filename:
 368                 usage(1, 'Too many output filenames')
 369             if (arguments[1] == '-'):
 370                 gopts.output_filename = '-'
 371                 outfile = sys.stdout
 372             else:
 373                 gopts.output_filename = arguments[1]
 374                 outfile = open(arguments[1], 'w')
 375     else:
 376         usage(1, 'Too many arguments')
 377
 378     if (infile is sys.stdin) and sys.stdin.isatty():
 379         if (outfile is sys.stdout) and sys.stdout.isatty():
 380             usage()
 381         usage(1, 'Filtering from console is forbidden')
 382
 383     if not gopts.host_name:
 384         import socket
 385         gopts.host_name = socket.gethostname()
 386
 387     gopts.outfile = outfile
 388     output = outfile.write
 389
 390     try:
 391         decode_message(email.message_from_file(infile))
 392     finally:
 393         infile.close()
 394         outfile.close()