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] [--save-headers|body|message 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_if_needed(s, charset):
  38     if charset and charset.lower() <> g.default_encoding:
  39         s = unicode(s, charset, "replace").encode(g.default_encoding, "replace")
  40     return s
  41
  42
  43 def _decode_header(s):
  44     """Return a decoded string according to RFC 2047.
  45     NOTE: This is almost the same as email.Utils.decode.
  46     """
  47     import email.Header
  48
  49     L = email.Header.decode_header(s)
  50     if not isinstance(L, list):
  51         # s wasn't decoded
  52         return s
  53
  54     rtn = []
  55     for atom, charset in L:
  56         if charset is None:
  57             rtn.append(atom)
  58         else:
  59             rtn.append(recode_if_needed(atom, charset))
  60         rtn.append(' ')
  61     del rtn[-1] # remove the last space
  62
  63     # Now that we've decoded everything, we just need to join all the parts
  64     # together into the final string.
  65     return ''.join(rtn)
  66
  67 def decode_header(msg, header):
  68     "Decode mail header (if exists) and put it back, if it was encoded"
  69
  70     if msg.has_key(header):
  71         value = msg[header]
  72         new_value = _decode_header(value)
  73         if new_value <> value: # do not bother to touch msg if not changed
  74             set_header(msg, header, new_value)
  75
  76
  77 def decode_header_param(msg, header, param):
  78     "Decode mail header's parameter (if exists) and put it back, if it was encoded"
  79
  80     if msg.has_key(header):
  81         value = msg.get_param(param, header=header)
  82         if value:
  83             if isinstance(value, tuple):
  84                 new_value = recode_if_needed(value[2], value[0])
  85             else:
  86                 new_value = _decode_header(value)
  87             if new_value <> value: # do not bother to touch msg if not changed
  88                 msg.set_param(param, new_value, header)
  89
  90
  91 def _get_exceptions(list):
  92     return [x[1:].lower() for x in list[1:] if x[0]=='-']
  93
  94 def _decode_headers_params(msg, header, decode_all_params, param_list):
  95     if decode_all_params:
  96         params = msg.get_params(header=header)
  97         if params:
  98             for param, value in params:
  99                 if param not in param_list:
 100                     decode_header_param(msg, header, param)
 101     else:
 102         for param in param_list:
 103             decode_header_param(msg, header, param)
 104
 105 def _remove_headers_params(msg, header, remove_all_params, param_list):
 106     if remove_all_params:
 107         params = msg.get_params(header=header)
 108         if params:
 109             if param_list:
 110                 for param, value in params:
 111                     if param not in param_list:
 112                         msg.del_param(param, header)
 113             else:
 114                 value = msg[header]
 115                 if value is None: # No such header
 116                     return
 117                 if ';' not in value: # There are no parameters
 118                     return
 119                 del msg[header] # Delete all such headers
 120                 # Get the value without parameters and set it back
 121                 msg[header] = value.split(';')[0].strip()
 122     else:
 123         for param in param_list:
 124             msg.del_param(param, header)
 125
 126 def decode_headers(msg):
 127     "Decode message headers according to global options"
 128
 129     for header_list in g.remove_headers:
 130         header_list = header_list.split(',')
 131         if header_list[0] == '*': # Remove all headers except listed
 132             header_list = _get_exceptions(header_list)
 133             for header in msg.keys():
 134                 if header.lower() not in header_list:
 135                     del msg[header]
 136         else: # Remove listed headers
 137             for header in header_list:
 138                 del msg[header]
 139
 140     for header_list, param_list in g.remove_headers_params:
 141         header_list = header_list.split(',')
 142         param_list = param_list.split(',')
 143         remove_all_params = param_list[0] == '*' # Remove all params except listed
 144         if remove_all_params:
 145             param_list = _get_exceptions(param_list)
 146         if header_list[0] == '*': # Remove for all headers except listed
 147             header_list = _get_exceptions(header_list)
 148             for header in msg.keys():
 149                 if header.lower() not in header_list:
 150                     _remove_headers_params(msg, header, remove_all_params, param_list)
 151         else: # Decode for listed headers
 152             for header in header_list:
 153                 _remove_headers_params(msg, header, remove_all_params, param_list)
 154
 155     for header_list in g.decode_headers:
 156         header_list = header_list.split(',')
 157         if header_list[0] == '*': # Decode all headers except listed
 158             header_list = _get_exceptions(header_list)
 159             for header in msg.keys():
 160                 if header.lower() not in header_list:
 161                     decode_header(msg, header)
 162         else: # Decode listed headers
 163             for header in header_list:
 164                 decode_header(msg, header)
 165
 166     for header_list, param_list in g.decode_header_params:
 167         header_list = header_list.split(',')
 168         param_list = param_list.split(',')
 169         decode_all_params = param_list[0] == '*' # Decode all params except listed
 170         if decode_all_params:
 171             param_list = _get_exceptions(param_list)
 172         if header_list[0] == '*': # Decode for all headers except listed
 173             header_list = _get_exceptions(header_list)
 174             for header in msg.keys():
 175                 if header.lower() not in header_list:
 176                     _decode_headers_params(msg, header, decode_all_params, param_list)
 177         else: # Decode for listed headers
 178             for header in header_list:
 179                 _decode_headers_params(msg, header, decode_all_params, param_list)
 180
 181
 182 def set_header(msg, header, value):
 183     "Replace header"
 184
 185     if msg.has_key(header):
 186         msg.replace_header(header, value)
 187     else:
 188         msg[header] = value
 189
 190
 191 def set_content_type(msg, newtype, charset=None):
 192     msg.set_type(newtype)
 193
 194     if charset:
 195         msg.set_param("charset", charset, "Content-Type")
 196
 197
 198 caps = None # Globally stored mailcap database; initialized only if needed
 199
 200 def decode_body(msg, s):
 201     "Decode body to plain text using first copiousoutput filter from mailcap"
 202
 203     import mailcap, tempfile
 204
 205     global caps
 206     if caps is None:
 207         caps = mailcap.getcaps()
 208
 209     content_type = msg.get_content_type()
 210     filename = tempfile.mktemp()
 211     command = None
 212
 213     entries = mailcap.lookup(caps, content_type, "view")
 214     for entry in entries:
 215         if entry.has_key('copiousoutput'):
 216             if entry.has_key('test'):
 217                 test = mailcap.subst(entry['test'], content_type, filename)
 218                 if test and os.system(test) != 0:
 219                     continue
 220             command = mailcap.subst(entry["view"], content_type, filename)
 221             break
 222
 223     if not command:
 224         return s
 225
 226     file = open(filename, 'w')
 227     file.write(s)
 228     file.close()
 229
 230     pipe = os.popen(command, 'r')
 231     s = pipe.read()
 232     pipe.close()
 233     os.remove(filename)
 234
 235     set_content_type(msg, "text/plain")
 236     msg["X-MIME-Autoconverted"] = "from %s to text/plain by %s id %s" % (content_type, g.host_name, command.split()[0])
 237
 238     return s
 239
 240
 241 def recode_charset(msg, s):
 242     "Recode charset of the message to the default charset"
 243
 244     save_charset = charset = msg.get_content_charset()
 245     if charset and charset.lower() <> g.default_encoding:
 246         s = recode_if_needed(s, charset)
 247         content_type = msg.get_content_type()
 248         set_content_type(msg, content_type, g.default_encoding)
 249         msg["X-MIME-Autoconverted"] = "from %s to %s by %s id %s" % (save_charset, g.default_encoding, g.host_name, me)
 250     return s
 251
 252
 253 def totext(msg, instring):
 254     "Convert instring content to text"
 255
 256     # Decode body and recode charset
 257     s = decode_body(msg, instring)
 258     if g.recode_charset:
 259         s = recode_charset(msg, s)
 260
 261     output_headers(msg)
 262     output(s)
 263     return s
 264
 265
 266 def _save_message(msg, outstring, save_headers=False, save_body=False):
 267     for header, param in (
 268         ("Content-Disposition", "filename"),
 269         ("Content-Type", "name"),
 270     ):
 271         fname = msg.get_param(param, header=header)
 272         if fname:
 273             fname = '-' + fname
 274             break
 275     else:
 276         fname = ''
 277     g.save_counter += 1
 278     fname = str(g.save_counter) + fname
 279
 280     global output
 281     save_output = output
 282     outfile = open_output_file(fname)
 283     output = outfile.write
 284     if save_headers:
 285         output_headers(msg)
 286     if save_body:
 287         output(outstring)
 288     outfile.close()
 289     output = save_output
 290
 291
 292 def decode_part(msg):
 293     "Decode one part of the message"
 294
 295     decode_headers(msg)
 296
 297     # Test all mask lists and find what to do with this content type
 298     masks = []
 299     ctype = msg.get_content_type()
 300     if ctype:
 301         masks.append(ctype)
 302     mtype = msg.get_content_maintype()
 303     if mtype:
 304         masks.append(mtype + '/*')
 305     masks.append('*/*')
 306
 307     left_binary = False
 308     for content_type in masks:
 309         if content_type in g.totext_mask or \
 310            content_type in g.decoded_binary_mask:
 311             break
 312         elif content_type in g.binary_mask:
 313             left_binary = True
 314             break
 315
 316     encoding = msg["Content-Transfer-Encoding"]
 317     if left_binary or encoding in (None, '', '7bit', '8bit', 'binary'):
 318         outstring = msg.get_payload()
 319     else: # Decode from transfer ecoding to text or binary form
 320         outstring = msg.get_payload(decode=1)
 321         set_header(msg, "Content-Transfer-Encoding", "8bit")
 322         msg["X-MIME-Autoconverted"] = "from %s to 8bit by %s id %s" % (encoding, g.host_name, me)
 323
 324     for content_type in masks:
 325         if content_type in g.totext_mask:
 326             outstring = totext(msg, outstring)
 327             break
 328         elif content_type in g.binary_mask or \
 329              content_type in g.decoded_binary_mask:
 330             output_headers(msg)
 331             output(outstring)
 332             break
 333         elif content_type in g.ignore_mask:
 334             output_headers(msg)
 335             output("\nMessage body of type %s skipped.\n" % ctype)
 336             break
 337         elif content_type in g.error_mask:
 338             break
 339     else:
 340         # Neither content type nor masks were listed - decode by default
 341         outstring = totext(msg, outstring)
 342
 343     for content_type in masks:
 344         if content_type in g.save_headers_mask:
 345             _save_message(msg, outstring, save_headers=True, save_body=False)
 346         elif content_type in g.save_body_mask:
 347             _save_message(msg, outstring, save_headers=False, save_body=True)
 348         elif content_type in g.save_message_mask:
 349             _save_message(msg, outstring, save_headers=True, save_body=True)
 350
 351     for content_type in masks:
 352         if content_type in g.error_mask:
 353             raise ValueError, "content type %s prohibited" % ctype
 354
 355 def decode_multipart(msg):
 356     "Decode multipart"
 357
 358     decode_headers(msg)
 359     output_headers(msg)
 360
 361     if msg.preamble: # Preserve the first part, it is probably not a RFC822-message
 362         output(msg.preamble) # Usually it is just a few lines of text (MIME warning)
 363     if msg.preamble is not None:
 364         output("\n")
 365
 366     first_subpart = True
 367     boundary = msg.get_boundary()
 368
 369     for subpart in msg.get_payload():
 370         if boundary:
 371             if first_subpart:
 372                 first_subpart = False
 373             else:
 374                 output("\n")
 375             output("--%s\n" % boundary)
 376
 377         # Recursively decode all parts of the subpart
 378         decode_message(subpart)
 379
 380     if boundary:
 381         output("\n--%s--\n" % boundary)
 382
 383     if msg.epilogue:
 384         output(msg.epilogue)
 385
 386
 387 def decode_message(msg):
 388     "Decode message"
 389
 390     if msg.is_multipart():
 391         decode_multipart(msg)
 392     elif len(msg): # Simple one-part message (there are headers) - decode it
 393         decode_part(msg)
 394     else: # Not a message, just text - copy it literally
 395         output(msg.as_string())
 396
 397
 398 def open_output_file(filename):
 399     return open(os.path.join(g.destination_dir, filename), 'w')
 400
 401
 402 class GlobalOptions:
 403     from m_lib.defenc import default_encoding
 404     recode_charset = 1 # recode charset of message body
 405
 406     host_name = None
 407
 408     # A list of headers to decode
 409     decode_headers = ["From", "To", "Cc", "Reply-To", "Mail-Followup-To",
 410                       "Subject"]
 411
 412     # A list of headers parameters to decode
 413     decode_header_params = [
 414         ("Content-Type", "name"),
 415         ("Content-Disposition", "filename"),
 416     ]
 417
 418     # A list of headers to remove
 419     remove_headers = []
 420     # A list of headers parameters to remove
 421     remove_headers_params = []
 422
 423     # A list of header/value pairs to set
 424     set_header_value = []
 425     # A list of header/parameter/value triples to set
 426     set_header_param = []
 427
 428     totext_mask = [] # A list of content-types to decode
 429     binary_mask = [] # A list of content-types to pass through
 430     decoded_binary_mask = [] # A list of content-types to pass through (content-transfer-decoded)
 431     ignore_mask = [] # Ignore (skip, do not decode and do not include into output)
 432     error_mask = []  # Raise error if encounter one of these
 433
 434     save_counter = 0
 435     save_headers_mask = []
 436     save_body_mask = []
 437     save_message_mask = []
 438
 439     input_filename = None
 440     output_filename = None
 441     destination_dir = os.curdir
 442
 443 g = GlobalOptions
 444
 445
 446 def get_opts():
 447     from getopt import getopt, GetoptError
 448
 449     try:
 450         options, arguments = getopt(sys.argv[1:],
 451             'hVcCDPH:f:d:p:r:R:b:B:e:i:t:O:o:',
 452             ['help', 'version', 'host=',
 453              'save-headers=', 'save-body=', 'save-message=',
 454              'set-header=', 'set-param='])
 455     except GetoptError:
 456         usage(1)
 457
 458     for option, value in options:
 459         if option in ('-h', '--help'):
 460             usage()
 461         elif option in ('-V', '--version'):
 462             version()
 463         elif option == '-c':
 464             g.recode_charset = 1
 465         elif option == '-C':
 466             g.recode_charset = 0
 467         elif option in ('-H', '--host'):
 468             g.host_name = value
 469         elif option == '-f':
 470             g.default_encoding = value
 471         elif option == '-d':
 472             if value.startswith('*'):
 473                 g.decode_headers = []
 474             g.decode_headers.append(value)
 475         elif option == '-D':
 476             g.decode_headers = []
 477         elif option == '-p':
 478             g.decode_header_params.append(value.split(':', 1))
 479         elif option == '-P':
 480             g.decode_header_params = []
 481         elif option == '-r':
 482             g.remove_headers.append(value)
 483         elif option == '-R':
 484             g.remove_headers_params.append(value.split(':', 1))
 485         elif option == '--set-header':
 486             g.set_header_value.append(value.split(':', 1))
 487         elif option == '--set-param':
 488             header, value = value.split(':', 1)
 489             if '=' in value:
 490                 param, value = value.split('=', 1)
 491             else:
 492                 param, value = value.split(':', 1)
 493             g.set_header_param.append((header, param, value))
 494         elif option == '-t':
 495             g.totext_mask.append(value)
 496         elif option == '-B':
 497             g.binary_mask.append(value)
 498         elif option == '-b':
 499             g.decoded_binary_mask.append(value)
 500         elif option == '-i':
 501             g.ignore_mask.append(value)
 502         elif option == '-e':
 503             g.error_mask.append(value)
 504         elif option == '--save-headers':
 505             g.save_headers_mask.append(value)
 506         elif option == '--save-body':
 507             g.save_body_mask.append(value)
 508         elif option == '--save-message':
 509             g.save_message_mask.append(value)
 510         elif option == '-O':
 511             g.destination_dir = value
 512         elif option == '-o':
 513             g.output_filename = value
 514         else:
 515             usage(1)
 516
 517     return arguments
 518
 519
 520 if __name__ == "__main__":
 521     arguments = get_opts()
 522
 523     la = len(arguments)
 524     if la == 0:
 525         g.input_filename = '-'
 526         infile = sys.stdin
 527         if g.output_filename:
 528             outfile = open_output_file(g.output_filename)
 529         else:
 530             g.output_filename = '-'
 531             outfile = sys.stdout
 532     elif la in (1, 2):
 533         if (arguments[0] == '-'):
 534             g.input_filename = '-'
 535             infile = sys.stdin
 536         else:
 537             g.input_filename = arguments[0]
 538             infile = open(arguments[0], 'r')
 539         if la == 1:
 540             if g.output_filename:
 541                 outfile = open_output_file(g.output_filename)
 542             else:
 543                 g.output_filename = '-'
 544                 outfile = sys.stdout
 545         elif la == 2:
 546             if g.output_filename:
 547                 usage(1, 'Too many output filenames')
 548             if (arguments[1] == '-'):
 549                 g.output_filename = '-'
 550                 outfile = sys.stdout
 551             else:
 552                 g.output_filename = arguments[1]
 553                 outfile = open_output_file(g.output_filename)
 554     else:
 555         usage(1, 'Too many arguments')
 556
 557     if (infile is sys.stdin) and sys.stdin.isatty():
 558         if (outfile is sys.stdout) and sys.stdout.isatty():
 559             usage()
 560         usage(1, 'Filtering from console is forbidden')
 561
 562     if not g.host_name:
 563         import socket
 564         g.host_name = socket.gethostname()
 565
 566     g.outfile = outfile
 567     output = outfile.write
 568
 569     msg = email.message_from_file(infile)
 570
 571     for header, value in g.set_header_value:
 572         set_header(msg, header, value)
 573
 574     for header, param, value in g.set_header_param:
 575         if header in msg:
 576             msg.set_param(param, value, header)
 577
 578     try:
 579         decode_message(msg)
 580     finally:
 581         infile.close()
 582         outfile.close()