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,...]] [--set-header header:value] [--set-param header:param=value] [-Bbeit mask] [-O dest_dir] [-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(g.default_encoding, "replace")
  39
  40 def recode_if_needed(s, charset):
  41     if charset and charset.lower() <> g.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 g.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 g.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 g.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 g.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, g.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() <> g.default_encoding:
 252         s = recode_if_needed(s, charset)
 253         content_type = msg.get_content_type()
 254         set_content_type(msg, content_type, g.default_encoding)
 255         msg["X-MIME-Autoconverted"] = "from %s to %s by %s id %s" % (save_charset, g.default_encoding, g.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 g.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
 276     # Test all mask lists and find what to do with this content type
 277     masks = []
 278     ctype = msg.get_content_type()
 279     if ctype:
 280         masks.append(ctype)
 281     mtype = msg.get_content_maintype()
 282     if mtype:
 283         masks.append(mtype + '/*')
 284     masks.append('*/*')
 285
 286     left_binary = False
 287     for content_type in masks:
 288         if content_type in g.binary_mask:
 289             left_binary = True
 290             break
 291
 292     encoding = msg["Content-Transfer-Encoding"]
 293     if left_binary or encoding in (None, '', '7bit', '8bit', 'binary'):
 294         outstring = msg.get_payload()
 295     else: # Decode from transfer ecoding to text or binary form
 296         outstring = msg.get_payload(decode=1)
 297         set_header(msg, "Content-Transfer-Encoding", "8bit")
 298         msg["X-MIME-Autoconverted"] = "from %s to 8bit by %s id %s" % (encoding, g.host_name, me)
 299
 300     for content_type in masks:
 301         if content_type in g.totext_mask:
 302             totext(msg, outstring)
 303             return
 304         elif content_type in g.binary_mask or \
 305              content_type in g.decoded_binary_mask:
 306             output_headers(msg)
 307             output(outstring)
 308             return
 309         elif content_type in g.ignore_mask:
 310             output_headers(msg)
 311             output("\nMessage body of type `%s' skipped.\n" % content_type)
 312             return
 313         elif content_type in g.error_mask:
 314             raise ValueError, "content type `%s' prohibited" % content_type
 315
 316     # Neither content type nor masks were listed - decode by default
 317     totext(msg, outstring)
 318
 319
 320 def decode_multipart(msg):
 321     "Decode multipart"
 322
 323     decode_headers(msg)
 324     output_headers(msg)
 325
 326     if msg.preamble: # Preserve the first part, it is probably not a RFC822-message
 327         output(msg.preamble) # Usually it is just a few lines of text (MIME warning)
 328     if msg.preamble is not None:
 329         output("\n")
 330
 331     first_subpart = True
 332     boundary = msg.get_boundary()
 333
 334     for subpart in msg.get_payload():
 335         if boundary:
 336             if first_subpart:
 337                 first_subpart = False
 338             else:
 339                 output("\n")
 340             output("--%s\n" % boundary)
 341
 342         # Recursively decode all parts of the subpart
 343         decode_message(subpart)
 344
 345     if boundary:
 346         output("\n--%s--\n" % boundary)
 347
 348     if msg.epilogue:
 349         output(msg.epilogue)
 350
 351
 352 def decode_message(msg):
 353     "Decode message"
 354
 355     if msg.is_multipart():
 356         decode_multipart(msg)
 357     elif len(msg): # Simple one-part message (there are headers) - decode it
 358         decode_part(msg)
 359     else: # Not a message, just text - copy it literally
 360         output(msg.as_string())
 361
 362
 363 class GlobalOptions:
 364     from m_lib.defenc import default_encoding
 365     recode_charset = 1 # recode charset of message body
 366
 367     host_name = None
 368
 369     # A list of headers to decode
 370     decode_headers = ["From", "To", "Cc", "Reply-To", "Mail-Followup-To",
 371                       "Subject"]
 372
 373     # A list of headers parameters to decode
 374     decode_header_params = [
 375         ("Content-Type", "name"),
 376         ("Content-Disposition", "filename"),
 377     ]
 378
 379     # A list of headers to remove
 380     remove_headers = []
 381     # A list of headers parameters to remove
 382     remove_headers_params = []
 383
 384     # A list of header/value pairs to set
 385     set_header_value = []
 386     # A list of header/parameter/value triples to set
 387     set_header_param = []
 388
 389     totext_mask = [] # A list of content-types to decode
 390     binary_mask = [] # A list of content-types to pass through
 391     decoded_binary_mask = [] # A list of content-types to pass through (content-transfer-decoded)
 392     ignore_mask = [] # Ignore (skip, do not decode and do not include into output)
 393     error_mask = []  # Raise error if encounter one of these
 394
 395     input_filename = None
 396     output_filename = None
 397     destination_dir = os.curdir
 398
 399 g = GlobalOptions
 400
 401
 402 def get_opts():
 403     from getopt import getopt, GetoptError
 404
 405     try:
 406         options, arguments = getopt(sys.argv[1:],
 407             'hVcCDPH:f:d:p:r:R:b:B:e:i:t:O:o:',
 408             ['help', 'version', 'host=', 'set-header=', 'set-param='])
 409     except GetoptError:
 410         usage(1)
 411
 412     for option, value in options:
 413         if option in ('-h', '--help'):
 414             usage()
 415         elif option in ('-V', '--version'):
 416             version()
 417         elif option == '-c':
 418             g.recode_charset = 1
 419         elif option == '-C':
 420             g.recode_charset = 0
 421         elif option in ('-H', '--host'):
 422             g.host_name = value
 423         elif option == '-f':
 424             g.default_encoding = value
 425         elif option == '-d':
 426             if value.startswith('*'):
 427                 g.decode_headers = []
 428             g.decode_headers.append(value)
 429         elif option == '-D':
 430             g.decode_headers = []
 431         elif option == '-p':
 432             g.decode_header_params.append(value.split(':', 1))
 433         elif option == '-P':
 434             g.decode_header_params = []
 435         elif option == '-r':
 436             g.remove_headers.append(value)
 437         elif option == '-R':
 438             g.remove_headers_params.append(value.split(':', 1))
 439         elif option == '--set-header':
 440             g.set_header_value.append(value.split(':', 1))
 441         elif option == '--set-param':
 442             header, value = value.split(':', 1)
 443             if '=' in value:
 444                 param, value = value.split('=', 1)
 445             else:
 446                 param, value = value.split(':', 1)
 447             g.set_header_param.append((header, param, value))
 448         elif option == '-t':
 449             g.totext_mask.append(value)
 450         elif option == '-B':
 451             g.binary_mask.append(value)
 452         elif option == '-b':
 453             g.decoded_binary_mask.append(value)
 454         elif option == '-i':
 455             g.ignore_mask.append(value)
 456         elif option == '-e':
 457             g.error_mask.append(value)
 458         elif option == '-O':
 459             g.destination_dir = value
 460         elif option == '-o':
 461             g.output_filename = value
 462         else:
 463             usage(1)
 464
 465     return arguments
 466
 467
 468 if __name__ == "__main__":
 469     arguments = get_opts()
 470
 471     la = len(arguments)
 472     if la == 0:
 473         g.input_filename = '-'
 474         infile = sys.stdin
 475         if g.output_filename:
 476             outfile = open(os.path.join(g.destination_dir, g.output_filename), 'w')
 477         else:
 478             g.output_filename = '-'
 479             outfile = sys.stdout
 480     elif la in (1, 2):
 481         if (arguments[0] == '-'):
 482             g.input_filename = '-'
 483             infile = sys.stdin
 484         else:
 485             g.input_filename = arguments[0]
 486             infile = open(arguments[0], 'r')
 487         if la == 1:
 488             if g.output_filename:
 489                 outfile = open(os.path.join(g.destination_dir, g.output_filename), 'w')
 490             else:
 491                 g.output_filename = '-'
 492                 outfile = sys.stdout
 493         elif la == 2:
 494             if g.output_filename:
 495                 usage(1, 'Too many output filenames')
 496             if (arguments[1] == '-'):
 497                 g.output_filename = '-'
 498                 outfile = sys.stdout
 499             else:
 500                 g.output_filename = arguments[1]
 501                 outfile = open(os.path.join(g.destination_dir, g.output_filename), 'w')
 502     else:
 503         usage(1, 'Too many arguments')
 504
 505     if (infile is sys.stdin) and sys.stdin.isatty():
 506         if (outfile is sys.stdout) and sys.stdout.isatty():
 507             usage()
 508         usage(1, 'Filtering from console is forbidden')
 509
 510     if not g.host_name:
 511         import socket
 512         g.host_name = socket.gethostname()
 513
 514     g.outfile = outfile
 515     output = outfile.write
 516
 517     msg = email.message_from_file(infile)
 518
 519     for header, value in g.set_header_value:
 520         msg[header] = value
 521
 522     for header, param, value in g.set_header_param:
 523         if header in msg:
 524             msg.set_param(param, value, header)
 525
 526     try:
 527         decode_message(msg)
 528     finally:
 529         infile.close()
 530         outfile.close()