src.main.java.com.mebigfatguy.fbcontrib.detect.SuspiciousShadedClassUse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fb-contrib Show documentation

An auxiliary findbugs.sourceforge.net plugin for java bug detectors that fall outside the narrow scope of detectors to be packaged with the product itself.

There is a newer version: 7.6.8

Show newest version

/*
 * fb-contrib - Auxiliary detectors for Java programs
 * Copyright (C) 2005-2018 Dave Brosius
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package com.mebigfatguy.fbcontrib.detect;

import java.util.List;
import java.util.Set;

import com.mebigfatguy.fbcontrib.utils.BugType;
import com.mebigfatguy.fbcontrib.utils.OpcodeUtils;
import com.mebigfatguy.fbcontrib.utils.SignatureUtils;
import com.mebigfatguy.fbcontrib.utils.UnmodifiableList;
import com.mebigfatguy.fbcontrib.utils.UnmodifiableSet;
import com.mebigfatguy.fbcontrib.utils.Values;

import edu.umd.cs.findbugs.BugInstance;
import edu.umd.cs.findbugs.BugReporter;
import edu.umd.cs.findbugs.BytecodeScanningDetector;
import edu.umd.cs.findbugs.internalAnnotations.SlashedClassName;

public class SuspiciousShadedClassUse extends BytecodeScanningDetector {

    private static final String SSCU_EXCEPTION_PACKAGES = "fb-contrib.sscu.exceptions";

    private static final Set SUSPICIOUS_ROOTS = UnmodifiableSet.create(
    // @formatter:off
        "/org/",
        "/com/",
        "/edu/"
    // @formatter:on
    );

    private final List knownExceptions = UnmodifiableList.create(
    // @formatter:off
        "uk/org/lidalia/",
        "au/com/bytecode/",
        "uk/org/okapibarcode"
    // @formatter:on
    );

    private BugReporter bugReporter;

    public SuspiciousShadedClassUse(BugReporter bugReporter) {
        this.bugReporter = bugReporter;

        String exceptions = System.getProperty(SSCU_EXCEPTION_PACKAGES, "");
        for (String ex : exceptions.split(Values.WHITESPACE_COMMA_SPLIT)) {
            if (!ex.isEmpty()) {
                knownExceptions.add(ex.replace('.', '/'));
            }
        }
    }

    @Override
    public void sawOpcode(int seen) {

        if (OpcodeUtils.isStandardInvoke(seen)) {
            String invokedCls = getClassConstantOperand();

            for (String suspiciousRoot : SUSPICIOUS_ROOTS) {
                int rootPos = invokedCls.indexOf(suspiciousRoot);
                if (rootPos >= 0) {
                    if (!isKnownException(invokedCls)) {
                        String invokedPrefix = invokedCls.substring(0, rootPos);
                        String[] parts = invokedPrefix.split("/");
                        if (!SignatureUtils.similarPackages(invokedCls, getClassName(), Math.min(2, parts.length))) {
                            bugReporter.reportBug(new BugInstance(this, BugType.SSCU_SUSPICIOUS_SHADED_CLASS_USE.name(), NORMAL_PRIORITY).addClass(this)
                                    .addMethod(this).addSourceLine(this));
                        }
                    }
                }
            }
        }
    }

    /**
     * determines if a suspected class is actually one of the known classes that have taken a bad package form by putting a tld later on in the package
     * structure
     *
     * @param clsName
     *            the classname to check
     * @return whether the classname is an exception
     */
    private boolean isKnownException(@SlashedClassName String clsName) {
        for (String exceptionCls : knownExceptions) {
            if (clsName.startsWith(exceptionCls)) {
                return true;
            }
        }

        return false;
    }
}