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.List;
    28
    29  /**
    30   * This rule detects the issue of missing Open Graph namespace.
    31   *
    32   * @see OpenGraphNamespaceFix
    33   *
    34   * @author Michele Mostarda (mostarda@fbk.eu)
    35   * @author Davide Palmisano (palmisano@fbk.eu)
    36   */
    37  public class MissingOpenGraphNamespaceRule implements Rule {
    38
    39      @Override
    40      public String getHRName() {
    41          return "missing-opengraph-namespace-rule";
    42      }
    43
    44      @Override
    45      public boolean applyOn(DOMDocument document, @SuppressWarnings("rawtypes") RuleContext context,
    46              ValidationReportBuilder validationReportBuilder) {
    47          List<Node> metas = document.getNodes("/HTML/HEAD/META");
    48          boolean foundPrecondition = false;
    49          for (Node meta : metas) {
    50              Node propertyNode = meta.getAttributes().getNamedItem("property");
    51              if (propertyNode != null && propertyNode.getTextContent().indexOf("og:") == 0) {
    52                  foundPrecondition = true;
    53                  break;
    54              }
    55          }
    56          if (foundPrecondition) {
    57              Node htmlNode = document.getNode("/HTML");
    58              if (htmlNode.getAttributes().getNamedItem("xmlns:og") == null) {
    59                  validationReportBuilder.reportIssue(ValidationReport.IssueLevel.ERROR,
    60                          "Missing OpenGraph namespace declaration.", htmlNode);
    61                  return true;
    62              }
    63          }
    64          return false;
    65      }
    66  }