com.cflint.plugins.CFLintScannerAdapter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of CFLint Show documentation
A static code analysis tool for ColdFusion (in the spirit of FindBugs and Lint). With CFLint, you are able to analyze your ColdFusion code base for code violations.
There is a newer version: 1.5.0
Show newest version
package com.cflint.plugins;

import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.cflint.BugList;
import com.cflint.config.CFLintPluginInfo.PluginInfoRule;
import com.cflint.config.CFLintPluginInfo.PluginInfoRule.PluginParameter;

import cfml.parsing.cfscript.CFExpression;
import cfml.parsing.cfscript.script.CFScriptStatement;
import net.htmlparser.jericho.Element;

/**
 * Lint Rule Plugins can extend this adapter instead of implementing all the
 * methods of CFLintScanner (and CFLintStructureListener)
 */
public class CFLintScannerAdapter implements CFLintScanner, CFLintStructureListener {

    private Map params = new HashMap<>();

    /**
     * Empty implementation
     */
    @Override
    public void expression(final CFExpression expression, final Context context, final BugList bugs) {
        //empty body for Adapter
    }

    /**
     * Empty implementation
     */
    @Override
    public void element(final Element element, final Context context, final BugList bugs) {
        //empty body for Adapter
    }

    /**
     * Empty implementation
     */
    @Override
    public void expression(final CFScriptStatement expression, final Context context, final BugList bugs) {
        //empty body for Adapter
    }

    /**
     * @deprecated - Use context.getConfiguration().setParameter()
     */
    @Override
    @Deprecated
    public void setParameter(final String name, final Object value) {
        if (name != null) {
            params.put(name.toLowerCase(), value);
            params.put(name, value);
        }
    }

    /**
     * @deprecated - Use context.getConfiguration().getParameter()
     * get the property from the configuration.
     * This can be overriden with -DcheckerClass.propertyname=value
     *
     * @param name      the name of the parameter
     * @return          the value of the parameter
     */
    @Deprecated
    public String getParameter(final String name, final PluginInfoRule ... infoRules ) {
        final String propertyForName = System.getProperty(getClass().getSimpleName() + "." + name);
        if (propertyForName != null && propertyForName.trim().length() > 0) {
            return propertyForName;
        }
        if(name != null && infoRules != null && infoRules.length>0 && infoRules[0].getParameters()!=null){
            for(PluginParameter contextParm : infoRules[0].getParameters()){
                if(name.equalsIgnoreCase(contextParm.getName()) && contextParm.getValue()!=null){
                    return contextParm.getValue().toString();
                }
            }
        }
        if (name != null && params.get(name.toLowerCase()) != null) {
            return params.get(name.toLowerCase()).toString();
        }

        return null;
    }

    /**
     * @deprecated - Use context.getConfiguration().getParameterNotNull()
    */
    @Deprecated
    public String getParameterNotNull(final String name, final PluginInfoRule ... infoRules ) {
        final String retval = getParameter(name, infoRules);
        if(retval != null){
            return retval;
        }
        return "";
    }
    /**
     * @deprecated - Use context.getConfiguration().getParameter()
    */
    @SuppressWarnings("unchecked")
    @Deprecated
    public  E getParameter(final String name, final Class clazz, final PluginInfoRule ... infoRules ) {
        final String propertyForName = System.getProperty(getClass().getSimpleName() + "." + name);
        if (propertyForName != null && propertyForName.trim().length() > 0) {
            if (clazz.equals(String.class)) {
                return (E) propertyForName;
            }
            if (List.class.isAssignableFrom(clazz)) {
                return (E) Arrays.asList(propertyForName.split(","));
            }
            System.err.println("Cannot associate property " + getClass().getSimpleName() + "." + name + " as a " + clazz.getName());
        }
        if(name != null && infoRules != null && infoRules.length>0 && infoRules[0].getParameters()!=null){
            for(PluginParameter contextParm : infoRules[0].getParameters()){
                if(name.equalsIgnoreCase(contextParm.getName()) && contextParm.getValue()!=null){
                    return (E) contextParm.getValue();
                }
            }
        }
        if (name != null && params.get(name.toLowerCase()) != null) {
            return (E) params.get(name.toLowerCase());
        }

        return null;
    }

    /**
     * Return parameter split by comma
     *
     * @param name      the name of the parameter
     * @return          the value of the parameter as a list of strings
     */
    public List getParameterAsList(final String name, final PluginInfoRule ... infoRules ) {
        return Arrays.asList(getParameterNotNull(name,infoRules).split(","));
    }

    public int currentLine(final CFExpression expression, final Context context) {
        return expression.getLine() + context.startLine() - 1;
    }

    public Map getParams() {
        return params;
    }

    /**
     * Default implementation does nothing
     */
    @Override
    public void startFile(final String fileName, final BugList bugs) {
        //empty body for Adapter
    }

    /**
     * Default implementation does nothing
     */
    @Override
    public void endFile(final String fileName, final BugList bugs) {
        //empty body for Adapter
    }

    /**
     * Default implementation does nothing
     */
    @Override
    public void startComponent(final Context context, final BugList bugs) {
        //empty body for Adapter
    }

    /**
     * Default implementation does nothing
     */
    @Override
    public void endComponent(final Context context, final BugList bugs) {
        //empty body for Adapter
    }

    /**
     * Default implementation does nothing
     */
    @Override
    public void startFunction(final Context context, final BugList bugs) {
        //empty body for Adapter
    }

    /**
     * Default implementation does nothing
     */
    @Override
    public void endFunction(final Context context, final BugList bugs) {
        //empty body for Adapter
    }
}