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