org.sonar.plugins.web.checks.attributes.AttributeValidationCheck Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-web-plugin Show documentation

Analyze HTML (also within PHP/Ruby/etc. templates) and JSP/JSF code.

There is a newer version: 2.3

/*
 * Sonar Web Plugin
 * Copyright (C) 2010 Matthijs Galesloot
 * [email protected]
 *
 * Licensed under the Apache License, Version 2.0 (the "License")
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.sonar.plugins.web.checks.attributes;

import org.apache.commons.lang.StringUtils;
import org.sonar.check.Cardinality;
import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;
import org.sonar.plugins.web.checks.AbstractPageCheck;
import org.sonar.plugins.web.node.Attribute;
import org.sonar.plugins.web.node.TagNode;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * Checker for values of attributes. A list of values might be specified as normal values or RegExpressions.
 *
 * @author Matthijs Galesloot
 * @since 1.1
 */
@Rule(key = "AttributeValidationCheck", priority = Priority.MAJOR, cardinality = Cardinality.MULTIPLE)
public class AttributeValidationCheck extends AbstractPageCheck {

  @RuleProperty
  private QualifiedAttribute[] attributes;

  @RuleProperty
  private String values;

  private Pattern pattern;

  public String getAttributes() {
    return getAttributesAsString(attributes);
  }

  public String getValues() {
    return values;
  }

  private boolean isValidValue(Attribute a) {

    if (StringUtils.isEmpty(a.getValue())) {
      return true;
    }

    Matcher m = pattern.matcher(a.getValue());
    return m.matches();
  }

  public void setAttributes(String qualifiedAttributes) {
    this.attributes = parseAttributes(qualifiedAttributes);
  }

  public void setValues(String values) {
    this.values = values;
    pattern = Pattern.compile(values);
  }

  @Override
  public void startElement(TagNode element) {

    if (attributes == null) {
      return;
    }

    for (Attribute a : getMatchingAttributes(element, attributes)) {
      if (!isValidValue(a)) {
        createViolation(element.getStartLinePosition(), "The attribute '" + a.getName() + "' does not respect the value constraint: " + values);
      }
    }
  }
}