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) 2005 -- Benjamin Mako Hill <mako@bork.hampshire.edu>
   7 # Author/Software Homepage at: http://mako.cc
   8
   9 # This software comes with ABSOLUTELY NO WARRANTY.
  10 # This is free software and is licensed under the GNU GPL.
  11
  12 __copyright__ = "Copyright (c) 2004 Benjamin Mako Hill"
  13 __author__ = "Benjamin Mako Hill <mako@debian.org>"
  14
  15 ### Configuration Options
  16 ###########################################
  17
  18 # location of the sendmail binary
  19 sendmail = "/usr/sbin/sendmail"
  20
  21 # list of mimetype which are, for the sake of this program, not
  22 # attachments
  23 ignored_types = ( "applica/pgp-signat", "application/pgp-signature" )
  24
  25 # list of regular expressions which we will view as being indicative
  26 # of an attachment
  27 attachment_regexes = [ r'\battach(ed|ment|ing)?\b(?im)',
  28                        r'\balleg(o|at[oaie]|ando)' ]
  29
  30
  31 ### No Edit Below This Line
  32 ###########################################
  33
  34 import sys
  35 import os
  36 import email
  37 import re
  38
  39 ## SUB: send message
  40 def send_message():
  41     mailpipe = os.popen("%s -t" % sendmail, 'w')
  42     mailpipe.write( message_string )
  43     sys.exit( mailpipe.close() )
  44
  45 ## SUB: print error message
  46 def print_error():
  47     print >>sys.stderr, \
  48 """(Your message mentions attachments but does not include any.
  49
  50 Either:
  51
  52  (1) Add an attachment or add \"CONFIRM\" (in ALLCAPS to beginning of
  53      the subject of the message and resend.  \"CONFIRM\" will be
  54      stripped from your message subject befor the message is sent.
  55
  56
  57  (2) Add a \"X-AttachCheck-Override: Yes\" header the message.
  58
  59 Read the documentation for AttachCheck for more details."""
  60
  61 # get the mail from stdin
  62 message_string = sys.stdin.read()
  63 message = email.message_from_string( message_string )
  64
  65 attachment_expected = False
  66 attachment_seen = False
  67 text_seen = False
  68
  69 for part in message.walk():
  70
  71     # check to see if this part is a plain text entry
  72     if part.get_content_type() == "text/plain":
  73
  74         # if this is the second text block, we should interrate
  75         # through things
  76         if text_seen:
  77             attachment_seen = True
  78         # otherwise, mark that we've now seen one text field
  79         else:
  80             text_seen = True
  81
  82         # search for the word "attach" or "attached" or "attachment"
  83         # in the body of the message
  84         for regex in attachment_regexes:
  85
  86             if re.search( regex, part.get_payload() ):
  87                 attachment_expected = True
  88
  89     # check to see if this mime-type is something we can ignore
  90     elif ( re.match( r'message/(?m)', part.get_content_type() ) or
  91            re.match( r'multipart/(?m)', part.get_content_type() ) or
  92            part.get_content_type() in ignored_types ):
  93         continue
  94
  95     # if it's not text and it's an ignored type, it's a seen attachment
  96     else:
  97         attachment_seen = True
  98
  99 # now check to see if we are expecting an attachment
 100 if attachment_expected:
 101
 102     # if we are expecting an attachment and we've seen one, we should
 103     # send the file and be done with things
 104     if attachment_seen:
 105         send_message()
 106
 107     # if we are expected have not seen it, we need to check to see if
 108     # the mail has been confirmed
 109
 110     else:
 111         # check for the confirmation
 112
 113         if re.search( r'Subject: CONFIRM', message_string ):
 114             message_string = re.sub( r'(Subject: )(CONFIRM )(.*?)\n',
 115                                      r'\1\3\n', message_string )
 116             send_message()
 117
 118         elif message.get( 'X-AttachCheck-Override' ) == "Yes":
 119             send_message()
 120
 121         else:
 122             print_error()
 123             sys.exit( 1 )
 124
 125
 126 # if we are not expecting anything more, we should send the message
 127 else:
 128     send_message()