com.cflint.plugins.core.UnusedLocalVarChecker 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.core;

import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import com.cflint.BugList;
import com.cflint.plugins.CFLintScannerAdapter;
import com.cflint.plugins.Context;

import cfml.parsing.cfscript.CFExpression;
import cfml.parsing.cfscript.CFFullVarExpression;
import cfml.parsing.cfscript.CFIdentifier;
import cfml.parsing.cfscript.CFMember;
import cfml.parsing.cfscript.CFVarDeclExpression;
import net.htmlparser.jericho.Element;

public class UnusedLocalVarChecker extends CFLintScannerAdapter {
    final String severity = "INFO";

    protected CFScopes scopes = new CFScopes();
    // LinkedHashMap is ordered.
    protected Map localVariables = new LinkedHashMap();
    //protected Map variableLineNo = new HashMap();
    
    protected List usedTagAttributes=null;
    
    @Override
    public void expression(final CFExpression expression, final Context context, final BugList bugs) {
    	if (expression instanceof CFFullVarExpression) {
            final CFFullVarExpression fullVarExpression = (CFFullVarExpression) expression;
            final CFExpression variable = fullVarExpression.getExpressions().get(0);
            if (variable instanceof CFIdentifier) {
                final String name = ((CFIdentifier) variable).getName();
                if (!scopes.isCFScoped(name)) {
                    localVariables.put(name.toLowerCase(), new VarInfo(name, true));
                } else if ((scopes.isLocalScoped(name) || scopes.isVariablesScoped(name)) && fullVarExpression.getExpressions().size() > 1) {
                    final CFExpression variable2 = fullVarExpression.getExpressions().get(1);
                    if (variable2 instanceof CFIdentifier) {
                        final String namepart=((CFIdentifier) variable2).getName();
                        localVariables.put(namepart.toLowerCase(), new VarInfo(namepart, true));
                    }
                }
            }
            for (CFExpression subexpr : ((CFFullVarExpression) expression).getExpressions()) {
                if (subexpr instanceof CFMember) {
                    CFMember memberExpr = (CFMember) subexpr;
                    if (memberExpr.getExpression() != null) {
                        expression(memberExpr.getExpression(), context, bugs);
                    }
                }
            }
        } else if (expression instanceof CFVarDeclExpression) {
            final String name = ((CFVarDeclExpression) expression).getName();
            final int lineNo = expression.getLine() + context.startLine() - 1;
            if(!scopes.isCFScoped(name)){
                addLocalVariable(name, lineNo);
            }
        } else if (expression instanceof CFIdentifier) {
            final String name = ((CFIdentifier) expression).getName();
            if(name != null){
                localVariables.put(name.toLowerCase(), new VarInfo(name, true));
            }
        }
    }

    protected void addLocalVariable(final String variable, final Integer lineNo) {
        if (variable != null && localVariables.get(variable.toLowerCase()) == null) {
            localVariables.put(variable.toLowerCase(), new VarInfo(variable, false));
            setLocalVariableLineNo(variable, lineNo);
        }
    }

    protected void setLocalVariableLineNo(final String variable, final Integer lineNo) {
        if (variable != null && localVariables.get(variable.toLowerCase()) != null) {
            localVariables.get(variable.toLowerCase()).lineNumber=lineNo;
        }
    }

    @Override
    public void startFunction(final Context context, final BugList bugs) {
        localVariables.clear();    }

    @Override
    public void endFunction(final Context context, final BugList bugs) {
        // sort by line number
        for (final VarInfo variable : localVariables.values()) {
            final Boolean used = variable.used;
            if (!used) {
                final String name = variable.name;
                final Integer lineNo = variable.lineNumber;
                context.addMessage("UNUSED_LOCAL_VARIABLE", name, lineNo);
            }
        }
    }

    public static class VarInfo{
        Boolean used;
        Integer lineNumber;
        String name;
        
        public VarInfo(String name, Boolean used){
            this.name=name;
            this.used=used;
        }
    }
    
    @Override
    public void element(final Element element, final Context context, final BugList bugs) {
        try{
            for(String tagInfo: usedTagAttributes){
                final String parts[] = (tagInfo + "//").split("/");
                if(element.getName()!= null && parts[0].equals(element.getName().toLowerCase())){
                    final String name = element.getAttributeValue(parts[1]);
                    if(name!= null && localVariables.containsKey(name.toLowerCase())){
                        localVariables.put(name.toLowerCase(), new VarInfo(name, true));
                    }
                }
            }
        }catch(Exception e){
            System.err.println(e.getMessage() + " in UnusedLocalVarChecker");
        }
    }

    @Override
    public void setParameter(String name, Object value) {
        super.setParameter(name, value);
        if("UsedTagAttributes".equals(name)){
            usedTagAttributes = getParameter("UsedTagAttributes",List.class);
        }
    }
}