com.cflint.plugins.core.ArgHintChecker 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.io.BufferedReader;
import java.io.IOException;
import java.io.StringReader;
import java.util.HashMap;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

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.CFAssignmentExpression;
import cfml.parsing.cfscript.CFExpression;
import cfml.parsing.cfscript.script.CFFuncDeclStatement;
import cfml.parsing.cfscript.script.CFFunctionParameter;
import cfml.parsing.cfscript.script.CFScriptStatement;
import net.htmlparser.jericho.Element;

public class ArgHintChecker extends CFLintScannerAdapter {

	@Override
	public void element(final Element element, final Context context, final BugList bugs) {
		if (element.getName().equals("cfargument")) {
			final String name = element.getAttributeValue("name");
			final String hint = element.getAttributeValue("hint");
			if (hint == null || hint.length() == 0) {
				context.addMessage("ARG_HINT_MISSING", name);
			}
		}
	}

	@Override
	public void expression(CFScriptStatement expression, Context context, BugList bugs) {
		if(expression instanceof CFFuncDeclStatement){
			final CFFuncDeclStatement funcDeclStatement = (CFFuncDeclStatement) expression;
			final String _mlText = PrecedingCommentReader.getMultiLine(context, expression.getToken());
			final String mlText = _mlText==null?null:_mlText.replaceFirst("^/\\*", "").replaceAll("\\*/$", "").trim();
			
			//Read the function comments to get the javadoc style annotations
			final Map annotations = new HashMap(); 
			if(mlText != null && !mlText.isEmpty()){
				final Pattern pattern = Pattern.compile("^.*\\s*@(\\w+)\\s+(.*+)$");
				BufferedReader reader = new BufferedReader(new StringReader(mlText));
				try {
					String line = reader.readLine();
					while(line != null){
						final Matcher matcher = pattern.matcher(line.trim());
						if (matcher.matches()) {
							annotations.put(matcher.group(1).trim().toLowerCase(),matcher.group(2).trim());
						}
						line = reader.readLine();
					}
				} catch (IOException e) {}
				
			}
			
			for (final CFFunctionParameter expr : funcDeclStatement.getFormals()) {
				if (expr != null && expr.getName() != null && !annotations.containsKey(expr.getName().toLowerCase())) {
					context.addMessage("ARG_HINT_MISSING_SCRIPT", expr.getName());
				}
			}

		}
	}
}