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.net.MalformedURLException;
28  import java.net.URL;
29  import java.util.ArrayList;
30  import java.util.List;
31  
32  /**
33   * This rule is able to detect whether an about value is a valid URL
34   * or otherwise is a valid relative URL.
35   *
36   * @author Michele Mostarda (mostarda@fbk.eu)
37   * @author Davide Palmisano (palmisano@fbk.eu)
38   */
39  public class AboutNotURIRule implements Rule {
40  
41      public static final String NODES_WITH_INVALID_ABOUT = "nodes-with-invalid-about";
42  
43      @Override
44      public String getHRName() {
45          return "about-not-uri-rule";
46      }
47  
48      @SuppressWarnings("unchecked")
49      @Override
50      public boolean applyOn(
51              DOMDocument document,
52              @SuppressWarnings("rawtypes") RuleContext context,
53              ValidationReportBuilder validationReportBuilder
54      ) {
55          final List<Node> nodesWithAbout = document.getNodesWithAttribute("about");
56          final List<Node> nodesWithInvalidAbout = new ArrayList<>();
57          for(Node nodeWithAbout : nodesWithAbout) {
58              if ( ! aboutIsValid(nodeWithAbout) ) {
59                  validationReportBuilder.reportIssue(
60                          ValidationReport.IssueLevel.ERROR,
61                          "Invalid about value for node, expected valid URL.",
62                          nodeWithAbout
63                  );
64                  nodesWithInvalidAbout.add(nodeWithAbout);
65              }
66          }
67          if(nodesWithInvalidAbout.isEmpty()) {
68              return false;
69          }
70          context.putData(NODES_WITH_INVALID_ABOUT, nodesWithInvalidAbout);
71          return true;
72      }
73  
74      private boolean aboutIsValid(Node n) {
75          final String aboutContent = n.getAttributes().getNamedItem("about").getTextContent();
76          if( isURL(aboutContent) ) {
77              return true;
78          }
79          final char firstChar = aboutContent.charAt(0);
80          return firstChar == '#' || firstChar == '/';
81      }
82  
83      private boolean isURL(String candidateIRIStr) {
84          try {
85              new URL(candidateIRIStr);
86          } catch (MalformedURLException murle) {
87              return false;
88          }
89          return true;
90      }
91  
92  }