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