com.cflint.plugins.core.FunctionHintChecker 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.regex.Matcher;
import java.util.regex.Pattern;

import com.cflint.BugInfo;
import com.cflint.BugList;
import com.cflint.plugins.CFLintScannerAdapter;
import com.cflint.plugins.Context;
import com.cflint.tools.CFTool;
import com.cflint.tools.PrecedingCommentReader;

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

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

	@Override
	public void element(final Element element, final Context context, final BugList bugs) {
		if (element.getName().equals("cffunction")) {
			final String name = element.getAttributeValue("name");
			final String hint = element.getAttributeValue("hint");
			if (hint == null || hint.trim().isEmpty()) {
				context.addMessage("FUNCTION_HINT_MISSING", context.getFunctionName());	
			}
		}
	}

	@Override
	public void expression(CFScriptStatement expression, Context context, BugList bugs) {
		if(expression instanceof CFFuncDeclStatement){
			final CFFuncDeclStatement funcDeclStatement = (CFFuncDeclStatement) expression;
			final CFExpression hintAttribute = CFTool.convertMap(funcDeclStatement.getAttributes()).get("hint");
			if(hintAttribute == null){
				final String _mlText = PrecedingCommentReader.getMultiLine(context, expression.getToken());
				final String mlText = _mlText==null?null:_mlText.replaceFirst("^/\\*", "").replaceAll("\\*/$", "").trim();
				if(mlText != null && !mlText.isEmpty()){
					final Pattern pattern = Pattern.compile(".*\\s*@hint\\s+([\\w,_]+)\\s*.*", Pattern.DOTALL);
					final Matcher matcher = pattern.matcher(mlText);
					if (matcher.matches()) {
						String hintText = matcher.group(1);
						if(hintText.trim().isEmpty()){
							context.addMessage("FUNCTION_HINT_MISSING", context.getFunctionName());		
						}
					}
				}else{
					context.addMessage("FUNCTION_HINT_MISSING", context.getFunctionName());
				}
			}
		}
	}
}