From d7972f80d142fac0d81e17ce973eee0dc0b63860 Mon Sep 17 00:00:00 2001
From: Xavier Le Vourch <xlv@users.sourceforge.net>
Date: Sat, 27 Oct 2007 17:44:43 +0000
Subject: [PATCH] AvoidUsingHardCodedIP now checks for IPv6 addresses as well

git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@5595 51baf565-9d33-0410-a72c-fc3788e3496d
---
 pmd/etc/changelog.txt                         |  2 +-
 .../rules/basic/xml/AvoidUsingHardCodedIP.xml | 39 +++++++++++++++
 pmd/rulesets/basic.xml                        |  4 +-
 .../rules/basic/AvoidUsingHardCodedIP.java    | 48 +++++++++++++++++++
 4 files changed, 90 insertions(+), 3 deletions(-)
 create mode 100644 pmd/src/net/sourceforge/pmd/rules/basic/AvoidUsingHardCodedIP.java

diff --git a/pmd/etc/changelog.txt b/pmd/etc/changelog.txt
index 59c7b0e899..187da01626 100644
--- a/pmd/etc/changelog.txt
+++ b/pmd/etc/changelog.txt
@@ -1,6 +1,6 @@
 ????, 2007 - 4.1:
 New rules:
-	Basic ruleset: AvoidUsingHardCodedIPRule,CheckResultSet
+	Basic ruleset: AvoidUsingHardCodedIP,CheckResultSet
 	Controversial ruleset: AvoidFinalLocalVariable,AvoidUsingShortType,AvoidUsingVolatile,AvoidUsingNativeCode,AvoidAccessibilityAlteration
 	Design ruleset: ClassWithOnlyPrivateConstructorsShouldBeFinal,EmptyMethodInAbstractClassShouldBeAbstract
 	Imports ruleset: TooManyStaticImports
diff --git a/pmd/regress/test/net/sourceforge/pmd/rules/basic/xml/AvoidUsingHardCodedIP.xml b/pmd/regress/test/net/sourceforge/pmd/rules/basic/xml/AvoidUsingHardCodedIP.xml
index 45dd79c47a..90a3becad4 100644
--- a/pmd/regress/test/net/sourceforge/pmd/rules/basic/xml/AvoidUsingHardCodedIP.xml
+++ b/pmd/regress/test/net/sourceforge/pmd/rules/basic/xml/AvoidUsingHardCodedIP.xml
@@ -61,4 +61,43 @@ public class Foo {
      ]]></code>
     </test-code>
 
+    <test-code>
+        <description><![CDATA[
+Not an IPv6 address string
+     ]]></description>
+        <expected-problems>0</expected-problems>
+        <code><![CDATA[
+public class Foo {
+  String B1  = "2001:0db8:0000:0000:0000:0000:1428:57ab  testing";
+  String B2  = "::1  testing";
+  String B3  = ":::1";
+  String B4  = "::1:";
+  String B5  = "0";
+  String B6  = "0000000000000";
+}
+     ]]></code>
+    </test-code>
+
+    <test-code>
+        <description><![CDATA[
+IPv6 addresses
+     ]]></description>
+        <expected-problems>11</expected-problems>
+        <code><![CDATA[
+public class Foo {
+	String A1  = "2001:0db8:0000:0000:0000:0000:1428:57ab";
+	String A2  = "2001:0db8:0000:0000:0000::1428:57ab";
+	String A3  = "2001:0db8:0:0:0:0:1428:57ab";
+	String A4  = "2001:0db8:0:0::1428:57ab";
+	String A5  = "2001:0db8::1428:57ab";
+	String A6  = "2001:db8::1428:57ab";
+	String A7  = "::1";
+	String A8  = "::ffff:12.34.56.78";
+	String A9  = "::ffff:0c22:384e";
+	String A10 = "0:0:0:0:0:ffff:0c22:384e";
+	String A11 = "2001:0db8:0000:0000:0000:0000:12.34.56.78";
+}
+     ]]></code>
+    </test-code>
+
 </test-data>
diff --git a/pmd/rulesets/basic.xml b/pmd/rulesets/basic.xml
index fc956b4d30..f2d827ea4d 100644
--- a/pmd/rulesets/basic.xml
+++ b/pmd/rulesets/basic.xml
@@ -1014,8 +1014,8 @@ public class Test {
     </rule>
 
     <rule   name="AvoidUsingHardCodedIP"
-            message="Do not hard code IP, even 127.0.0.1 !"
-            class="net.sourceforge.pmd.rules.GenericLiteralCheckerRule"
+            message="Do not hard code IPv4 or IPv6 addresses, even 127.0.0.1 !"
+            class="net.sourceforge.pmd.rules.basic.AvoidUsingHardCodedIP"
             externalInfoUrl="http://pmd.sourceforge.net/rules/basic.html#AvoidUsingHardCodedIP">
 	    <description>
 	    	<![CDATA[
diff --git a/pmd/src/net/sourceforge/pmd/rules/basic/AvoidUsingHardCodedIP.java b/pmd/src/net/sourceforge/pmd/rules/basic/AvoidUsingHardCodedIP.java
new file mode 100644
index 0000000000..3421985f4a
--- /dev/null
+++ b/pmd/src/net/sourceforge/pmd/rules/basic/AvoidUsingHardCodedIP.java
@@ -0,0 +1,48 @@
+package net.sourceforge.pmd.rules.basic;
+
+import java.net.InetAddress;
+import java.util.regex.Pattern;
+
+import net.sourceforge.pmd.AbstractRule;
+import net.sourceforge.pmd.ast.ASTLiteral;
+
+public class AvoidUsingHardCodedIP extends AbstractRule {
+
+    private static final String IPv4_REGEXP = "^\"[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\"$";
+    private static final String IPv6_REGEXP = "^\"[0-9a-fA-F:]+:[0-9a-fA-F]+\"$";
+    private static final String IPv4_MAPPED_IPv6_REGEXP = "^\"[0-9a-fA-F:]+:[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\"$";
+
+    private static final Pattern IPv4_PATTERM = Pattern.compile(IPv4_REGEXP);
+    private static final Pattern IPv6_PATTERM = Pattern.compile(IPv6_REGEXP);
+    private static final Pattern IPv4_MAPPED_IPv6_PATTERM = Pattern.compile(IPv4_MAPPED_IPv6_REGEXP);
+
+    /**
+     * This method checks if the Literal matches the pattern. If it does, a violation is logged.
+     */
+    public Object visit(ASTLiteral node, Object data) {
+        String image = node.getImage();
+        if (image == null || image.length() < 3 || image.charAt(0) != '"' ||
+                image.charAt(image.length()-1) != '"') {
+            return data;
+        }
+        
+	/* Tests before calls to matches() ensure that the literal is '"[0-9:].*"' */
+        char c = image.charAt(1);
+        if ((Character.isDigit(c) || c == ':') &&
+                (IPv4_PATTERM.matcher(image).matches() ||
+                        IPv6_PATTERM.matcher(image).matches() ||
+                        IPv4_MAPPED_IPv6_PATTERM.matcher(image).matches())) {
+            try {
+                // as patterns are not 100% accurate, test address
+                InetAddress.getByName(image.substring(1, image.length()-1));
+                
+                // no error creating address object, pattern must be valid
+                addViolation(data, node);
+            } catch (Exception e) {
+		// ignored: invalid format
+            }
+        }
+        return data;
+    }
+
+}