projects.mako.cc - attachcheck/blob - attachcheck

   1 #!/usr/bin/env python
   2
   3 # AttachCheck -- A MTA wrapper to help check outgoing email for
   4 # forgotten attachments.
   5
   6 # (c) 2004-2009 -- Benjamin Mako Hill <mako@atdot.cc>
   7 # Software Homepage at: http://mako.cc/projects/attachcheck
   8
   9 # This program is free software: you can redistribute it and/or modify
  10 # it under the terms of the GNU General Public License as published by
  11 # the Free Software Foundation, either version 3 of the License, or (at
  12 # your option) any later version.
  13
  14 # This program is distributed in the hope that it will be useful, but
  15 # WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 # General Public License for more details.
  18
  19 # You should have received a copy of the GNU General Public License
  20 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21
  22 __copyright__ = "Copyright (c) 2004-2009 Benjamin Mako Hill"
  23 __author__ = "Benjamin Mako Hill <mako@atdot.cc>"
  24
  25 ### Configuration Options
  26 ###########################################
  27
  28 # location of the sendmail binary
  29 sendmail = "/usr/sbin/sendmail"
  30
  31 # list of mimetype which are, for the sake of this program, not
  32 # attachments
  33 ignored_types = ( "applica/pgp-signat", "application/pgp-signature" )
  34
  35 # list of regular expressions which we will view as being indicative
  36 # of an attachment
  37 attachment_regexes = [ r'\battach(ed|ment|ing)?\b(?im)',
  38                        r'\balleg(o|at[oaie]|ando)(?im)' ]
  39
  40 # ignore quoted text (which might refer to attachments in previous emails)
  41 attachment_regexes = [ r'(^|^[^\n>].*)' + x for x in attachment_regexes ]
  42
  43 ### No Edit Below This Line
  44 ###########################################
  45
  46 import sys
  47 import os
  48 import email
  49 import re
  50
  51 ## SUB: send message
  52 def send_message():
  53
  54     global sendmail
  55
  56     # construct the sendmail pipe more safely (thanks iain murray!)
  57     cmd = sys.argv[:]
  58     cmd[0] = sendmail
  59
  60     from subprocess import Popen, PIPE
  61     process = Popen(cmd, stdin=PIPE)
  62     mailpipe = process.stdin
  63     mailpipe.write( message_string )
  64     mailpipe.close()
  65     sys.exit( process.wait() )
  66
  67 ## SUB: print error message
  68 def print_error():
  69     print >>sys.stderr, \
  70 """(Your message mentions attachments but does not include any.
  71
  72 Either:
  73
  74  (1) Add an attachment or add \"CONFIRM\" (in ALLCAPS to beginning of
  75      the subject of the message and resend.  \"CONFIRM\" will be
  76      stripped from your message subject befor the message is sent.
  77
  78
  79  (2) Add a \"X-AttachCheck-Override: Yes\" header the message.
  80
  81 Read the documentation for AttachCheck for more details."""
  82
  83 # get the mail from stdin
  84 message_string = sys.stdin.read()
  85 message = email.message_from_string( message_string )
  86
  87 attachment_expected = False
  88 attachment_seen = False
  89 text_seen = False
  90
  91 for part in message.walk():
  92
  93     # check to see if this part is a plain text entry
  94     if part.get_content_type() == "text/plain":
  95
  96         # if this is the second text block, we should interrate
  97         # through things
  98         if text_seen:
  99             attachment_seen = True
 100         # otherwise, mark that we've now seen one text field
 101         else:
 102             text_seen = True
 103
 104         # search for the word "attach" or "attached" or "attachment"
 105         # in the body of the message
 106         for regex in attachment_regexes:
 107
 108             if re.search( regex, part.get_payload() ):
 109                 attachment_expected = True
 110
 111     # check to see if this mime-type is something we can ignore
 112     elif ( re.match( r'message/(?m)', part.get_content_type() ) or
 113            re.match( r'multipart/(?m)', part.get_content_type() ) or
 114            part.get_content_type() in ignored_types ):
 115         continue
 116
 117     # if it's not text and it's an ignored type, it's a seen attachment
 118     else:
 119         attachment_seen = True
 120
 121 # now check to see if we are expecting an attachment
 122 if attachment_expected:
 123
 124     # if we are expecting an attachment and we've seen one, we should
 125     # send the file and be done with things
 126     if attachment_seen:
 127         send_message()
 128
 129     # if we are expected have not seen it, we need to check to see if
 130     # the mail has been confirmed
 131
 132     else:
 133         # check for the confirmation
 134
 135         if re.search( r'Subject: CONFIRM', message_string ):
 136             message_string = re.sub( r'(Subject: )(CONFIRM )(.*?)\n',
 137                                      r'\1\3\n', message_string )
 138             send_message()
 139
 140         elif message.get( 'X-AttachCheck-Override' ) == "Yes":
 141             send_message()
 142
 143         else:
 144             print_error()
 145             sys.exit( 1 )
 146
 147
 148 # if we are not expecting anything more, we should send the message
 149 else:
 150     send_message()