X-Git-Url: https://git.phdru.name/?p=mimedecode.git;a=blobdiff_plain;f=mimedecode.py;h=5459cbff73ab05dcc32ba5f7645ae5951a525cb8;hp=6c29a9680c8bb927fdbfd5f1b7ef7ac53227b16f;hb=5e0a0832c3c713d57cdc01b91b9e6a1c4ccc15f3;hpb=fb1bca196122731a2c21ecd9e37413f19337fcd2 diff --git a/mimedecode.py b/mimedecode.py index 6c29a96..5459cbf 100755 --- a/mimedecode.py +++ b/mimedecode.py @@ -1,15 +1,14 @@ #! /usr/bin/env python """Decode MIME message""" -from mimedecode_version import __version__, __author__, __copyright__, __license__ - import sys, os -import email - -try: - from cStringIO import StringIO -except ImportError: - from StringIO import StringIO +import subprocess +from mimedecode_version import __version__, \ + __author__, __copyright__, __license__ +if sys.version_info[0] >= 3: + # Replace email.message._formatparam with _formatparam from Python 2.7 + # to avoid re-encoding non-ascii params. + import formatparam_27 me = os.path.basename(sys.argv[0]) @@ -23,98 +22,183 @@ Broytman mimedecode.py version %s, %s def usage(code=0, errormsg=''): version(0) sys.stdout.write("""\ -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]] +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]] """ % me) if errormsg: - sys.stderr.write(errormsg + '\n') + sys.stderr.write(errormsg + os.linesep) sys.exit(code) def output_headers(msg): unix_from = msg.get_unixfrom() if unix_from: - output(unix_from + '\n') + output(unix_from) + output(os.linesep) for key, value in msg.items(): - output("%s: %s\n" % (key, value)) - output("\n") # End of headers - + output(key) + output(": ") + value = value.split(';', 1) + output(value[0]) + if len(value) == 2: + output(";") + output(_decode_header(value[1], strip=False)) + output(os.linesep) + output(os.linesep) # End of headers -def recode(s, charset): - return unicode(s, charset, "replace").encode(gopts.default_encoding, "replace") def recode_if_needed(s, charset): - if charset and charset.lower() <> gopts.default_encoding: - s = recode(s, charset) + if bytes is str: # Python2 + if isinstance(s, bytes) and \ + charset and charset.lower() != g.default_encoding: + s = s.decode(charset, "replace").\ + encode(g.default_encoding, "replace") + else: # Python3 + if isinstance(s, bytes): + s = s.decode(charset, "replace") return s -def _decode_header(s): +def _decode_header(s, strip=True): """Return a decoded string according to RFC 2047. NOTE: This is almost the same as email.Utils.decode. """ - from types import ListType - import email.Header + import email.header - L = email.Header.decode_header(s) - if not isinstance(L, ListType): + L = email.header.decode_header(s) + if not isinstance(L, list): # s wasn't decoded return s rtn = [] for atom, charset in L: - if charset is None: - rtn.append(atom) - else: - rtn.append(recode_if_needed(atom, charset)) - rtn.append(' ') - del rtn[-1] # remove the last space + atom = recode_if_needed(atom, charset or g.default_encoding) + if strip: + atom = atom.strip() + rtn.append(atom) # Now that we've decoded everything, we just need to join all the parts # together into the final string. - return ''.join(rtn) + return ' '.join(rtn) def decode_header(msg, header): "Decode mail header (if exists) and put it back, if it was encoded" - if msg.has_key(header): + if header in msg: value = msg[header] new_value = _decode_header(value) - if new_value <> value: # do not bother to touch msg if not changed + if new_value != value: # do not bother to touch msg if not changed set_header(msg, header, new_value) -def _decode_header_param(s): - return recode_if_needed(s[2], s[0]) - def decode_header_param(msg, header, param): "Decode mail header's parameter (if exists) and put it back, if it was encoded" - if msg.has_key(header): + if header in msg: value = msg.get_param(param, header=header) if value: - from types import TupleType - if isinstance(value, TupleType): - new_value = _decode_header_param(value) + if isinstance(value, tuple): + new_value = recode_if_needed(value[2], value[0]) else: new_value = _decode_header(value) - if new_value <> value: # do not bother to touch msg if not changed + if new_value != value: # do not bother to touch msg if not changed msg.set_param(param, new_value, header) +def _get_exceptions(list): + return [x[1:].lower() for x in list[1:] if x[0]=='-'] + +def _decode_headers_params(msg, header, decode_all_params, param_list): + if decode_all_params: + params = msg.get_params(header=header) + if params: + for param, value in params: + if param not in param_list: + decode_header_param(msg, header, param) + else: + for param in param_list: + decode_header_param(msg, header, param) + +def _remove_headers_params(msg, header, remove_all_params, param_list): + if remove_all_params: + params = msg.get_params(header=header) + if params: + if param_list: + for param, value in params: + if param not in param_list: + msg.del_param(param, header) + else: + value = msg[header] + if value is None: # No such header + return + if ';' not in value: # There are no parameters + return + del msg[header] # Delete all such headers + # Get the value without parameters and set it back + msg[header] = value.split(';')[0].strip() + else: + for param in param_list: + msg.del_param(param, header) + def decode_headers(msg): "Decode message headers according to global options" - for header in gopts.decode_headers: - decode_header(msg, header) - - for header, param in gopts.decode_header_params: - decode_header_param(msg, header, param) + for header_list in g.remove_headers: + header_list = header_list.split(',') + if header_list[0] == '*': # Remove all headers except listed + header_list = _get_exceptions(header_list) + for header in msg.keys(): + if header.lower() not in header_list: + del msg[header] + else: # Remove listed headers + for header in header_list: + del msg[header] + + for header_list, param_list in g.remove_headers_params: + header_list = header_list.split(',') + param_list = param_list.split(',') + remove_all_params = param_list[0] == '*' # Remove all params except listed + if remove_all_params: + param_list = _get_exceptions(param_list) + if header_list[0] == '*': # Remove for all headers except listed + header_list = _get_exceptions(header_list) + for header in msg.keys(): + if header.lower() not in header_list: + _remove_headers_params(msg, header, remove_all_params, param_list) + else: # Decode for listed headers + for header in header_list: + _remove_headers_params(msg, header, remove_all_params, param_list) + + for header_list in g.decode_headers: + header_list = header_list.split(',') + if header_list[0] == '*': # Decode all headers except listed + header_list = _get_exceptions(header_list) + for header in msg.keys(): + if header.lower() not in header_list: + decode_header(msg, header) + else: # Decode listed headers + for header in header_list: + decode_header(msg, header) + + for header_list, param_list in g.decode_header_params: + header_list = header_list.split(',') + param_list = param_list.split(',') + decode_all_params = param_list[0] == '*' # Decode all params except listed + if decode_all_params: + param_list = _get_exceptions(param_list) + if header_list[0] == '*': # Decode for all headers except listed + header_list = _get_exceptions(header_list) + for header in msg.keys(): + if header.lower() not in header_list: + _decode_headers_params(msg, header, decode_all_params, param_list) + else: # Decode for listed headers + for header in header_list: + _decode_headers_params(msg, header, decode_all_params, param_list) def set_header(msg, header, value): "Replace header" - if msg.has_key(header): + if header in msg: msg.replace_header(header, value) else: msg[header] = value @@ -139,13 +223,17 @@ def decode_body(msg, s): caps = mailcap.getcaps() content_type = msg.get_content_type() + if content_type.startswith('text/'): + charset = msg.get_content_charset() + else: + charset = None filename = tempfile.mktemp() command = None entries = mailcap.lookup(caps, content_type, "view") for entry in entries: - if entry.has_key('copiousoutput'): - if entry.has_key('test'): + if 'copiousoutput' in entry: + if 'test' in entry: test = mailcap.subst(entry['test'], content_type, filename) if test and os.system(test) != 0: continue @@ -155,18 +243,29 @@ def decode_body(msg, s): if not command: return s - file = open(filename, 'w') - file.write(s) - file.close() - - pipe = os.popen(command, 'r') - s = pipe.read() - pipe.close() + outfile = open(filename, 'wb') + if charset and bytes is not str and isinstance(s, bytes): # Python3 + s = s.decode(charset, "replace") + if not isinstance(s, bytes): + s = s.encode(g.default_encoding, "replace") + outfile.write(s) + outfile.close() + + pipe = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE) + new_s = pipe.stdout.read() + pipe.stdout.close() + if pipe.wait() == 0: # result=0, Ok + s = new_s + if bytes is not str and isinstance(s, bytes): # Python3 + s = s.decode(g.default_encoding, "replace") + if charset and not isinstance(s, bytes): + s = s.encode(charset, "replace") + set_content_type(msg, "text/plain") + msg["X-MIME-Autoconverted"] = "from %s to text/plain by %s id %s" % (content_type, g.host_name, command.split()[0]) + else: + msg["X-MIME-Autoconverted"] = "failed conversion from %s to text/plain by %s id %s" % (content_type, g.host_name, command.split()[0]) os.remove(filename) - set_content_type(msg, "text/plain") - msg["X-MIME-Autoconverted"] = "from %s to text/plain by %s id %s" % (content_type, gopts.host_name, command.split()[0]) - return s @@ -174,11 +273,11 @@ def recode_charset(msg, s): "Recode charset of the message to the default charset" save_charset = charset = msg.get_content_charset() - if charset and charset.lower() <> gopts.default_encoding: + if charset and charset.lower() != g.default_encoding: s = recode_if_needed(s, charset) content_type = msg.get_content_type() - set_content_type(msg, content_type, gopts.default_encoding) - msg["X-MIME-Autoconverted"] = "from %s to %s by %s id %s" % (save_charset, gopts.default_encoding, gopts.host_name, me) + set_content_type(msg, content_type, g.default_encoding) + msg["X-MIME-Autoconverted"] = "from %s to %s by %s id %s" % (save_charset, g.default_encoding, g.host_name, me) return s @@ -187,90 +286,233 @@ def totext(msg, instring): # Decode body and recode charset s = decode_body(msg, instring) - if gopts.recode_charset: + if g.recode_charset: s = recode_charset(msg, s) output_headers(msg) output(s) + return s + + +mimetypes = None + +def _guess_extension(ctype): + global mimetypes + if mimetypes is None: + import mimetypes + mimetypes.init() + user_mime_type = os.path.expanduser('~/.mime.types') + if os.path.exists(user_mime_type): + mimetypes._db.read(user_mime_type) + return mimetypes.guess_extension(ctype) + +def _save_message(msg, outstring, save_headers=False, save_body=False): + for header, param in ( + ("Content-Disposition", "filename"), + ("Content-Type", "name"), + ): + fname = msg.get_param(param, header=header) + if fname: + if isinstance(fname, tuple): + fname = fname[2] # Do not recode if it isn't recoded yet + try: + for forbidden in chr(0), '/', '\\': + if forbidden in fname: + raise ValueError + except ValueError: + continue + fname = '-' + fname + break + else: + fname = '' + g.save_counter += 1 + fname = str(g.save_counter) + fname + if '.' not in fname: + ext = _guess_extension(msg.get_content_type()) + if ext: fname += ext + + global output + save_output = output + outfile = open_output_file(fname) + def _output_bytes(s): + if not isinstance(s, bytes): + s = s.encode(g.default_encoding, "replace") + outfile.write(s) + output = _output_bytes + if save_headers: + output_headers(msg) + if save_body: + output(outstring) + outfile.close() + output = save_output def decode_part(msg): "Decode one part of the message" decode_headers(msg) - encoding = msg["Content-Transfer-Encoding"] - - if encoding in (None, '', '7bit', '8bit', 'binary'): - outstring = str(msg.get_payload()) - else: # Decode from transfer ecoding to text or binary form - outstring = str(msg.get_payload(decode=1)) - set_header(msg, "Content-Transfer-Encoding", "8bit") - msg["X-MIME-Autoconverted"] = "from %s to 8bit by %s id %s" % (encoding, gopts.host_name, me) # Test all mask lists and find what to do with this content type masks = [] ctype = msg.get_content_type() if ctype: masks.append(ctype) - mtype = msg.get_content_maintype() - if mtype: + mtype = ctype.split('/')[0] masks.append(mtype + '/*') masks.append('*/*') + left_binary = False for content_type in masks: - if content_type in gopts.totext_mask: - totext(msg, outstring) + if content_type in g.totext_mask or \ + content_type in g.decoded_binary_mask: + break + elif content_type in g.binary_mask: + left_binary = True + break + elif content_type in g.fully_ignore_mask: return - elif content_type in gopts.binary_mask: + + encoding = msg["Content-Transfer-Encoding"] + if left_binary or encoding in (None, '', '7bit', '8bit', 'binary'): + outstring = msg.get_payload() + else: # Decode from transfer ecoding to text or binary form + outstring = msg.get_payload(decode=1) + set_header(msg, "Content-Transfer-Encoding", "8bit") + msg["X-MIME-Autoconverted"] = "from %s to 8bit by %s id %s" % (encoding, g.host_name, me) + + for content_type in masks: + if content_type in g.totext_mask: + outstring = totext(msg, outstring) + break + elif content_type in g.binary_mask or \ + content_type in g.decoded_binary_mask: output_headers(msg) output(outstring) - return - elif content_type in gopts.ignore_mask: + break + elif content_type in g.ignore_mask: output_headers(msg) - output("\nMessage body of type `%s' skipped.\n" % content_type) - return - elif content_type in gopts.error_mask: - raise ValueError, "content type `%s' prohibited" % content_type + output("%sMessage body of type %s skipped.%s" % (os.linesep, ctype, os.linesep)) + break + elif content_type in g.error_mask: + break + else: + # Neither content type nor masks were listed - decode by default + outstring = totext(msg, outstring) - # Neither content type nor masks were listed - decode by default - totext(msg, outstring) + for content_type in masks: + if content_type in g.save_headers_mask: + _save_message(msg, outstring, save_headers=True, save_body=False) + if content_type in g.save_body_mask: + _save_message(msg, outstring, save_headers=False, save_body=True) + if content_type in g.save_message_mask: + _save_message(msg, outstring, save_headers=True, save_body=True) + for content_type in masks: + if content_type in g.error_mask: + raise ValueError("content type %s prohibited" % ctype) -def decode_file(infile): - "Decode the entire message" +def decode_multipart(msg): + "Decode multipart" - msg = email.message_from_file(infile) + decode_headers(msg) + boundary = msg.get_boundary() - if msg.is_multipart(): - decode_headers(msg) - output_headers(msg) + masks = [] + ctype = msg.get_content_type() + if ctype: + masks.append(ctype) + mtype = ctype.split('/')[0] + masks.append(mtype + '/*') + masks.append('*/*') - if msg.preamble: # Preserve the first part, it is probably not a RFC822-message - output(msg.preamble) # Usually it is just a few lines of text (MIME warning) + for content_type in masks: + if content_type in g.fully_ignore_mask: + return + elif content_type in g.ignore_mask: + output_headers(msg) + output("%sMessage body of type %s skipped.%s" % (os.linesep, ctype, os.linesep)) + if boundary: + output("%s--%s--%s" % (os.linesep, boundary, os.linesep)) + return - boundary = msg.get_boundary() + for content_type in masks: + if content_type in g.save_body_mask or \ + content_type in g.save_message_mask: + _out_l = [] + first_subpart = True + for subpart in msg.get_payload(): + if first_subpart: + first_subpart = False + else: + _out_l.append(os.linesep) + _out_l.append("--%s%s" % (boundary, os.linesep)) + _out_l.append(subpart.as_string()) + _out_l.append("%s--%s--%s" % (os.linesep, boundary, os.linesep)) + outstring = ''.join(_out_l) + break + else: + outstring = None - for subpart in msg.get_payload(): - output("\n--%s\n" % boundary) + for content_type in masks: + if content_type in g.save_headers_mask: + _save_message(msg, outstring, save_headers=True, save_body=False) + if content_type in g.save_body_mask: + _save_message(msg, outstring, save_headers=False, save_body=True) + if content_type in g.save_message_mask: + _save_message(msg, outstring, save_headers=True, save_body=True) + + for content_type in masks: + if content_type in g.error_mask: + raise ValueError("content type %s prohibited" % ctype) + + output_headers(msg) - if subpart.is_multipart(): # Recursively decode all parts of the subpart - newfile = StringIO(subpart.as_string()) - newfile.seek(0) - decode_file(newfile) + if msg.preamble: # Preserve the first part, it is probably not a RFC822-message + output(msg.preamble) # Usually it is just a few lines of text (MIME warning) + if msg.preamble is not None: + output(os.linesep) + + first_subpart = True + for subpart in msg.get_payload(): + if boundary: + if first_subpart: + first_subpart = False else: - decode_part(subpart) + output(os.linesep) + output("--%s%s" % (boundary, os.linesep)) - output("\n--%s--\n" % boundary) + # Recursively decode all parts of the subpart + decode_message(subpart) - if msg.epilogue: - output(msg.epilogue) + if boundary: + output("%s--%s--%s" % (os.linesep, boundary, os.linesep)) + + if msg.epilogue: + output(msg.epilogue) - else: - if msg.has_key("Content-Type"): # Simple one-part message - decode it - decode_part(msg) - else: # Not a message, just text - copy it literally - output(msg.as_string()) +def decode_message(msg): + "Decode message" + + if msg.is_multipart(): + decode_multipart(msg) + elif len(msg): # Simple one-part message (there are headers) - decode it + decode_part(msg) + else: # Not a message, just text - copy it literally + output(msg.as_string()) + + +def open_output_file(filename): + fullpath = os.path.abspath(os.path.join(g.destination_dir, filename)) + full_dir = os.path.dirname(fullpath) + create = not os.path.isdir(full_dir) + if create: + os.makedirs(full_dir) + try: + return open(fullpath, 'wb') + except: + if create: + os.removedirs(full_dir) class GlobalOptions: @@ -279,29 +521,54 @@ class GlobalOptions: host_name = None - decode_headers = ["From", "Subject"] # A list of headers to decode + # A list of headers to decode + decode_headers = ["From", "To", "Cc", "Reply-To", "Mail-Followup-To", + "Subject"] + + # A list of headers parameters to decode decode_header_params = [ ("Content-Type", "name"), ("Content-Disposition", "filename"), - ] # A list of headers' parameters to decode + ] + + # A list of headers to remove + remove_headers = [] + # A list of headers parameters to remove + remove_headers_params = [] + + # A list of header/value pairs to set + set_header_value = [] + # A list of header/parameter/value triples to set + set_header_param = [] totext_mask = [] # A list of content-types to decode - binary_mask = [] # A list to pass through - ignore_mask = [] # Ignore (skip, do not decode and do not include into output) + binary_mask = [] # A list of content-types to pass through + decoded_binary_mask = [] # A list of content-types to pass through (content-transfer-decoded) + ignore_mask = [] # Ignore (do not decode and do not include into output) but output a warning instead of the body + fully_ignore_mask = [] # Completely ignore - no headers, no body, no warning error_mask = [] # Raise error if encounter one of these + save_counter = 0 + save_headers_mask = [] + save_body_mask = [] + save_message_mask = [] + input_filename = None output_filename = None + destination_dir = os.curdir -gopts = GlobalOptions +g = GlobalOptions -def get_opt(): +def get_opts(): from getopt import getopt, GetoptError try: - options, arguments = getopt(sys.argv[1:], 'hVcCDPH:f:d:p:b:e:i:t:o:', - ['help', 'version', 'host']) + options, arguments = getopt(sys.argv[1:], + 'hVcCDPH:f:d:p:r:R:b:B:e:I:i:t:O:o:', + ['help', 'version', 'host=', + 'save-headers=', 'save-body=', 'save-message=', + 'set-header=', 'set-param=']) except GetoptError: usage(1) @@ -311,31 +578,58 @@ def get_opt(): elif option in ('-V', '--version'): version() elif option == '-c': - gopts.recode_charset = 1 + g.recode_charset = 1 elif option == '-C': - gopts.recode_charset = 0 + g.recode_charset = 0 elif option in ('-H', '--host'): - gopts.host_name = value + g.host_name = value elif option == '-f': - gopts.default_encoding = value + g.default_encoding = value elif option == '-d': - gopts.decode_headers.append(value) + if value.startswith('*'): + g.decode_headers = [] + g.decode_headers.append(value) elif option == '-D': - gopts.decode_headers = [] + g.decode_headers = [] elif option == '-p': - gopts.decode_header_params.append(value.split(':', 1)) + g.decode_header_params.append(value.split(':', 1)) elif option == '-P': - gopts.decode_header_params = [] + g.decode_header_params = [] + elif option == '-r': + g.remove_headers.append(value) + elif option == '-R': + g.remove_headers_params.append(value.split(':', 1)) + elif option == '--set-header': + g.set_header_value.append(value.split(':', 1)) + elif option == '--set-param': + header, value = value.split(':', 1) + if '=' in value: + param, value = value.split('=', 1) + else: + param, value = value.split(':', 1) + g.set_header_param.append((header, param, value)) elif option == '-t': - gopts.totext_mask.append(value) + g.totext_mask.append(value) + elif option == '-B': + g.binary_mask.append(value) elif option == '-b': - gopts.binary_mask.append(value) + g.decoded_binary_mask.append(value) + elif option == '-I': + g.fully_ignore_mask.append(value) elif option == '-i': - gopts.ignore_mask.append(value) + g.ignore_mask.append(value) elif option == '-e': - gopts.error_mask.append(value) + g.error_mask.append(value) + elif option == '--save-headers': + g.save_headers_mask.append(value) + elif option == '--save-body': + g.save_body_mask.append(value) + elif option == '--save-message': + g.save_message_mask.append(value) + elif option == '-O': + g.destination_dir = value elif option == '-o': - gopts.output_filename = value + g.output_filename = value else: usage(1) @@ -343,39 +637,39 @@ def get_opt(): if __name__ == "__main__": - arguments = get_opt() + arguments = get_opts() la = len(arguments) if la == 0: - gopts.input_filename = '-' + g.input_filename = '-' infile = sys.stdin - if gopts.output_filename: - outfile = open(gopts.output_filename, 'w') + if g.output_filename: + outfile = open_output_file(g.output_filename) else: - gopts.output_filename = '-' + g.output_filename = '-' outfile = sys.stdout elif la in (1, 2): if (arguments[0] == '-'): - gopts.input_filename = '-' + g.input_filename = '-' infile = sys.stdin else: - gopts.input_filename = arguments[0] + g.input_filename = arguments[0] infile = open(arguments[0], 'r') if la == 1: - if gopts.output_filename: - outfile = open(gopts.output_filename, 'w') + if g.output_filename: + outfile = open_output_file(g.output_filename) else: - gopts.output_filename = '-' + g.output_filename = '-' outfile = sys.stdout elif la == 2: - if gopts.output_filename: + if g.output_filename: usage(1, 'Too many output filenames') if (arguments[1] == '-'): - gopts.output_filename = '-' + g.output_filename = '-' outfile = sys.stdout else: - gopts.output_filename = arguments[1] - outfile = open(arguments[1], 'w') + g.output_filename = arguments[1] + outfile = open_output_file(g.output_filename) else: usage(1, 'Too many arguments') @@ -384,15 +678,32 @@ if __name__ == "__main__": usage() usage(1, 'Filtering from console is forbidden') - if not gopts.host_name: + if not g.host_name: import socket - gopts.host_name = socket.gethostname() + g.host_name = socket.gethostname() + + g.outfile = outfile + if hasattr(outfile, 'buffer'): + def output_bytes(s): + if not isinstance(s, bytes): + s = s.encode(g.default_encoding, "replace") + outfile.buffer.write(s) + output = output_bytes + else: + output = outfile.write + + import email + msg = email.message_from_file(infile) + + for header, value in g.set_header_value: + set_header(msg, header, value) - gopts.outfile = outfile - output = outfile.write + for header, param, value in g.set_header_param: + if header in msg: + msg.set_param(param, value, header) try: - decode_file(infile) + decode_message(msg) finally: infile.close() outfile.close()