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