View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *  http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17
    18  package org.apache.any23.validator.rule;
    19
    20  import org.apache.any23.validator.DOMDocument;
    21  import org.apache.any23.validator.Rule;
    22  import org.apache.any23.validator.RuleContext;
    23  import org.apache.any23.validator.ValidationReport;
    24  import org.apache.any23.validator.ValidationReportBuilder;
    25  import org.w3c.dom.Node;
    26
    27  import java.util.ArrayList;
    28  import java.util.List;
    29
    30  /**
    31   * Checks whether the meta attribute name is used to contain a property.
    32   *
    33   * @see MetaNameMisuseFix
    34   *
    35   * @author Davide Palmisano (palmisano@fbk.eu)
    36   * @author Michele Mostarda (mostarda@fbk.eu)
    37   */
    38  public class MetaNameMisuseRule implements Rule {
    39
    40      public static final String ERRORED_META_NODES = "errored-meta-nodes";
    41
    42      @Override
    43      public String getHRName() {
    44          return "meta-name-misuse-rule";
    45      }
    46
    47      @SuppressWarnings("unchecked")
    48      @Override
    49      public boolean applyOn(DOMDocument document, @SuppressWarnings("rawtypes") RuleContext context,
    50              ValidationReportBuilder validationReportBuilder) {
    51          List<Node> metaNodes = document.getNodes("/HTML/HEAD/META");
    52          boolean foundIssue = false;
    53          final List<Node> wrongMetaNodes = new ArrayList<>();
    54          for (Node metaNode : metaNodes) {
    55              Node nameNode = metaNode.getAttributes().getNamedItem("name");
    56              if (nameNode != null && nameNode.getTextContent().contains(":")) {
    57                  foundIssue = true;
    58                  wrongMetaNodes.add(metaNode);
    59                  validationReportBuilder.reportIssue(ValidationReport.IssueLevel.ERROR,
    60                          "Error detected in meta node: name property contains a prefixed value.", metaNode);
    61              }
    62          }
    63          context.putData(ERRORED_META_NODES, wrongMetaNodes);
    64          return foundIssue;
    65      }
    66
    67  }