Package com.mebigfatguy.fbcontrib.detect

Class CharsetIssues

java.lang.Object
edu.umd.cs.findbugs.visitclass.BetterVisitor
edu.umd.cs.findbugs.visitclass.PreorderVisitor
edu.umd.cs.findbugs.visitclass.AnnotationVisitor
edu.umd.cs.findbugs.visitclass.DismantleBytecode
edu.umd.cs.findbugs.BytecodeScanningDetector
com.mebigfatguy.fbcontrib.detect.CharsetIssues
All Implemented Interfaces:
edu.umd.cs.findbugs.Detector, edu.umd.cs.findbugs.Priorities, org.apache.bcel.classfile.Visitor
public class CharsetIssues extends edu.umd.cs.findbugs.BytecodeScanningDetector
looks for issues related to manually specified charsets by using string literals.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final edu.umd.cs.findbugs.BugReporter
    bugReporter
     
    private static final String
    CHARSET_SIG
     
    private int
    classVersion
     
    private static final Map<FQMethod,Integer>
    REPLACEABLE_ENCODING_METHODS
     
    private edu.umd.cs.findbugs.OpcodeStack
    stack
     
    static final Set<String>
    STANDARD_JDK7_ENCODINGS
     
    private static final Map<FQMethod,Integer>
    UNREPLACEABLE_ENCODING_METHODS
     

    Fields inherited from class edu.umd.cs.findbugs.visitclass.DismantleBytecode

    codeBytes, lineNumberTable, M_BR, M_CP, M_INT, M_PAD, M_R, M_UINT

    Fields inherited from interface edu.umd.cs.findbugs.Priorities

    EXP_PRIORITY, HIGH_PRIORITY, IGNORE_PRIORITY, LOW_PRIORITY, NORMAL_PRIORITY

  • Constructor Summary

    Constructors
    Constructor
    Description
    CharsetIssues(edu.umd.cs.findbugs.BugReporter bugReporter)
    constructs a CSI detector given the reporter to report bugs on

  • Method Summary

    Modifier and Type
    Method
    Description
    static Map<String,Integer>
    getReplaceableCharsetEncodings()
    used by external tools, lists the method signature checked for, for replaceable encoding methods
    static Map<String,Integer>
    getUnreplaceableCharsetEncodings()
    used by external tools, lists the method signature checked for, for unreplaceable encoding methods
    private static String
    replaceNthArgWithCharsetString(String sig, int stackOffset)
    rebuilds a signature replacing a String argument at a specified spot, with a Charset parameter.
    void
    sawOpcode(int seen)
    implements the visitor to look for method calls that take a parameter that either represents a encoding via a string, or takes a Charset.
    void
    visitClassContext(edu.umd.cs.findbugs.ba.ClassContext classContext)
    implements the visitor to make sure the class is at least 1.4, and if so continues, reseting the opcode stack
    void
    visitMethod(org.apache.bcel.classfile.Method obj)
    implements the visitor to reset the opcode stack for a new method

    Methods inherited from class edu.umd.cs.findbugs.BytecodeScanningDetector

    getClassContext, report, shouldVisitCode

    Methods inherited from class edu.umd.cs.findbugs.visitclass.DismantleBytecode

    afterOpcode, areOppositeBranches, atCatchBlock, beforeOpcode, getBranchFallThrough, getBranchOffset, getBranchTarget, getClassConstantOperand, getClassDescriptorOperand, getCodeByte, getConstantRefOperand, getDefaultSwitchOffset, getDottedClassConstantOperand, getFieldDescriptorOperand, getIntConstant, getLongConstant, getMaxPC, getMethodDescriptorOperand, getNameConstantOperand, getNextCodeByte, getNextOpcode, getNextPC, getOpcode, getPC, getPrevOpcode, getRefConstantOperand, getRefFieldIsStatic, getRegisterOperand, getSigConstantOperand, getStringConstantOperand, getSwitchLabels, getSwitchOffsets, getXClassOperand, getXFieldOperand, getXMethodOperand, isBranch, isMethodCall, isRegisterLoad, isRegisterStore, isRegisterStore, isReturn, isShift, isSwitch, isWideOpcode, printOpCode, sawBranchTo, sawClass, sawDouble, sawField, sawFloat, sawIMethod, sawInt, sawLong, sawMethod, sawRegister, sawString, visit

    Methods inherited from class edu.umd.cs.findbugs.visitclass.AnnotationVisitor

    getAnnotationParameterAsEnum, getAnnotationParameterAsString, getAnnotationParameterAsStringArray, visitAnnotation, visitAnnotation, visitParameterAnnotation, visitParameterAnnotation, visitSyntheticParameterAnnotation

    Methods inherited from class edu.umd.cs.findbugs.visitclass.PreorderVisitor

    amVisitingMainMethod, asUnsignedByte, doVisitMethod, getClassDescriptor, getClassName, getCode, getConstantPool, getDottedClassName, getDottedFieldSig, getDottedMethodSig, getDottedSuperclassName, getField, getFieldDescriptor, getFieldIsStatic, getFieldName, getFieldSig, getFullyQualifiedFieldName, getFullyQualifiedMethodName, getMethod, getMethodDescriptor, getMethodName, getMethodSig, getMethodVisitOrder, getNumberArguments, getNumberMethodArguments, getPackageName, getSizeOfSurroundingTryBlock, getSizeOfSurroundingTryBlock, getSourceFile, getStringFromIndex, getSuperclassName, getSurroundingCaughtExceptions, getSurroundingCaughtExceptions, getSurroundingCaughtExceptionTypes, getSurroundingTryBlock, getSurroundingTryBlock, getThisClass, getXClass, getXField, getXMethod, hasInterestingClass, hasInterestingMethod, isVisitMethodsInCallOrder, setupVisitorForClass, setVisitMethodsInCallOrder, shouldVisit, toString, visitAfter, visitAfter, visitAnnotationDefault, visitAnnotationEntry, visitBootstrapMethods, visitCode, visitConstantInvokeDynamic, visitConstantMethodHandle, visitConstantMethodType, visitConstantModule, visitConstantPackage, visitConstantPool, visitEnclosingMethod, visitingField, visitingMethod, visitInnerClasses, visitJavaClass, visitLineNumberTable, visitLocalVariableTable, visitMethodParameters, visitParameterAnnotationEntry, visitStackMap, visitStackMapEntry

    Methods inherited from class edu.umd.cs.findbugs.visitclass.BetterVisitor

    clone, report, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visitCodeException, visitConstantClass, visitConstantDouble, visitConstantFieldref, visitConstantFloat, visitConstantInteger, visitConstantInterfaceMethodref, visitConstantLong, visitConstantMethodref, visitConstantNameAndType, visitConstantString, visitConstantUtf8, visitConstantValue, visitDeprecated, visitExceptionTable, visitField, visitInnerClass, visitLineNumber, visitLocalVariable, visitLocalVariableTypeTable, visitSignature, visitSourceFile, visitSynthetic, visitUnknown

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.apache.bcel.classfile.Visitor

    visitConstantDynamic, visitMethodParameter, visitModule, visitModuleExports, visitModuleMainClass, visitModuleOpens, visitModulePackages, visitModuleProvides, visitModuleRequires, visitNestHost, visitNestMembers, visitRecord, visitRecordComponent, visitStackMapType

  • Field Details

    • CHARSET_SIG

      private static final String CHARSET_SIG

    • REPLACEABLE_ENCODING_METHODS

      private static final Map<FQMethod,Integer> REPLACEABLE_ENCODING_METHODS

    • UNREPLACEABLE_ENCODING_METHODS

      private static final Map<FQMethod,Integer> UNREPLACEABLE_ENCODING_METHODS

    • STANDARD_JDK7_ENCODINGS

      public static final Set<String> STANDARD_JDK7_ENCODINGS

    • bugReporter

      private final edu.umd.cs.findbugs.BugReporter bugReporter

    • stack

      private edu.umd.cs.findbugs.OpcodeStack stack

    • classVersion

      private int classVersion

  • Constructor Details

    • CharsetIssues

      public CharsetIssues(edu.umd.cs.findbugs.BugReporter bugReporter)
      constructs a CSI detector given the reporter to report bugs on
      Parameters:
      bugReporter - the sync of bug reports

  • Method Details

    • visitClassContext

      public void visitClassContext(edu.umd.cs.findbugs.ba.ClassContext classContext)
      implements the visitor to make sure the class is at least 1.4, and if so continues, reseting the opcode stack
      Specified by:
      visitClassContext in interface edu.umd.cs.findbugs.Detector
      Overrides:
      visitClassContext in class edu.umd.cs.findbugs.BytecodeScanningDetector
      Parameters:
      classContext - the currently parsed java class

    • visitMethod

      public void visitMethod(org.apache.bcel.classfile.Method obj)
      implements the visitor to reset the opcode stack for a new method
      Specified by:
      visitMethod in interface org.apache.bcel.classfile.Visitor
      Overrides:
      visitMethod in class edu.umd.cs.findbugs.visitclass.BetterVisitor
      Parameters:
      obj - the currently parsed method

    • sawOpcode

      public void sawOpcode(int seen)
      implements the visitor to look for method calls that take a parameter that either represents a encoding via a string, or takes a Charset. If the method can take both, and a string is presented for a standard charset available in jdk 7, and the code is compiled against 7, then report. It also looks for mistakes, encodings that aren't recognized in the current jvm.
      Overrides:
      sawOpcode in class edu.umd.cs.findbugs.visitclass.DismantleBytecode
      Parameters:
      seen - the currently parsed opcode

    • replaceNthArgWithCharsetString

      private static String replaceNthArgWithCharsetString(String sig, int stackOffset)
      rebuilds a signature replacing a String argument at a specified spot, with a Charset parameter.
      Parameters:
      sig - the signature to replace
      stackOffset - the offset of the parameter to replace
      Returns:
      a new signature with a Charset parameter

    • getUnreplaceableCharsetEncodings

      public static Map<String,Integer> getUnreplaceableCharsetEncodings()
      used by external tools, lists the method signature checked for, for unreplaceable encoding methods
      Returns:
      a map of these methods

    • getReplaceableCharsetEncodings

      public static Map<String,Integer> getReplaceableCharsetEncodings()
      used by external tools, lists the method signature checked for, for replaceable encoding methods
      Returns:
      a map of these methods