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