minor changes according to JLint
[mir.git] / source / mircoders / localizer / basic / MirBasicAntiAbuseFilterTypes.java
index 020605d..ef148e2 100755 (executable)
-/*\r
- * Copyright (C) 2001, 2002 The Mir-coders group\r
- *\r
- * This file is part of Mir.\r
- *\r
- * Mir is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * Mir is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with Mir; if not, write to the Free Software\r
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
- *\r
- * In addition, as a special exception, The Mir-coders gives permission to link\r
- * the code of this program with  any library licensed under the Apache Software License,\r
- * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library\r
- * (or with modified versions of the above that use the same license as the above),\r
- * and distribute linked combinations including the two.  You must obey the\r
- * GNU General Public License in all respects for all of the code used other than\r
- * the above mentioned libraries.  If you modify this file, you may extend this\r
- * exception to your version of the file, but you are not obligated to do so.\r
- * If you do not wish to do so, delete this exception statement from your version.\r
- */\r
-\r
-package mircoders.localizer.basic;\r
-\r
-import gnu.regexp.RE;\r
-\r
-import java.util.Arrays;\r
-import java.util.Iterator;\r
-import java.util.List;\r
-\r
-import mir.entity.Entity;\r
-import mir.session.Request;\r
-import mir.util.InternetFunctions;\r
-import mircoders.localizer.MirAntiAbuseFilterType;\r
-\r
-\r
-/**\r
- * <p>Title: </p>\r
- * <p>Description: </p>\r
- * <p>Copyright: Copyright (c) 2003</p>\r
- * <p>Company: </p>\r
- * @author not attributable\r
- * @version 1.0\r
- */\r
-\r
-public class MirBasicAntiAbuseFilterTypes {\r
-  private MirBasicAntiAbuseFilterTypes() {\r
-  }\r
-\r
-  public static abstract class BasicFilterType implements MirAntiAbuseFilterType {\r
-    private String name;\r
-\r
-    public BasicFilterType(String aName) {\r
-      name = aName;\r
-    }\r
-\r
-    public String getName() {\r
-      return name;\r
-    }\r
-  }\r
-\r
-  /**\r
-   * A basic ip filter. Supports x.x.x.x, x.x.x.x/x and x.x.x.x/x.x.x.x expressions.\r
-   *\r
-   * <p>Title: </p>\r
-   * <p>Description: </p>\r
-   * <p>Copyright: Copyright (c) 2003</p>\r
-   * <p>Company: </p>\r
-   * @author not attributable\r
-   * @version 1.0\r
-   */\r
-\r
-  public static class IPFilter extends BasicFilterType {\r
-    public IPFilter(String aName) {\r
-      super(aName);\r
-    }\r
-\r
-    public boolean validate(String anExpression) {\r
-      try {\r
-        InternetFunctions.isIpAddressInNetwork("1.1.1.1", anExpression);\r
-        return true;\r
-      }\r
-      catch (Throwable t) {\r
-        return false;\r
-      }\r
-    };\r
-\r
-    public boolean test(String anExpression, Entity anEntity, Request aRequest) {\r
-      try {\r
-        return InternetFunctions.isIpAddressInNetwork(aRequest.getHeader("ip"), anExpression);\r
-      }\r
-      catch (Throwable t) {\r
-        return false;\r
-      }\r
-    };\r
-  }\r
-\r
-  /**\r
-   * A regular expression filter.\r
-   *\r
-   * <p>Title: </p>\r
-   * <p>Description: </p>\r
-   * <p>Copyright: Copyright (c) 2003</p>\r
-   * <p>Company: </p>\r
-   * @author not attributable\r
-   * @version 1.0\r
-   */\r
-\r
-  public static class RegularExpressionFilter extends BasicFilterType {\r
-    private boolean exactMatch;\r
-    private boolean caseSensitive;\r
-    private int fieldKind;\r
-    private List selectedFields;\r
-\r
-    public static final int ENTITY_FIELDS = 0;\r
-    public static final int REQUEST_HEADERS = 2;\r
-\r
-    public RegularExpressionFilter(String aName) {\r
-      this(aName, false, false, null);\r
-    }\r
-\r
-    public RegularExpressionFilter(String aName, boolean aCaseSensitive, boolean anExactMatch, String[] aSelectedFields) {\r
-      this (aName, aCaseSensitive, anExactMatch, ENTITY_FIELDS, aSelectedFields);\r
-    }\r
-\r
-    public RegularExpressionFilter(String aName, boolean aCaseSensitive, boolean anExactMatch, int aFieldKind, String[] aSelectedFields) {\r
-      super(aName);\r
-\r
-      fieldKind = aFieldKind;\r
-\r
-      caseSensitive = aCaseSensitive;\r
-      exactMatch = anExactMatch;\r
-      if (aSelectedFields==null)\r
-        selectedFields = null;\r
-      else\r
-        selectedFields = Arrays.asList(aSelectedFields);\r
-    }\r
-\r
-    public boolean validate(String anExpression) {\r
-      try {\r
-        new RE(anExpression);\r
-        return true;\r
-      }\r
-      catch (Throwable t) {\r
-        return false;\r
-      }\r
-    };\r
-\r
-    public boolean test(String anExpression, Entity anEntity, Request aRequest) {\r
-      try {\r
-        Iterator j;\r
-        int flags = 0;\r
-\r
-        if (caseSensitive)\r
-          flags |= RE.REG_ICASE;\r
-\r
-        RE regularExpression = new RE(anExpression, RE.REG_ICASE);\r
-\r
-        switch (fieldKind) {\r
-          case REQUEST_HEADERS:\r
-            if (selectedFields != null) {\r
-              j = selectedFields.iterator();\r
-\r
-              while (j.hasNext()) {\r
-                String field = aRequest.getHeader( (String) j.next());\r
-\r
-                if (exactMatch) {\r
-                  if (field != null && regularExpression.isMatch(field)) {\r
-                    return true;\r
-                  }\r
-                }\r
-                else {\r
-                  if (field != null && regularExpression.getMatch(field) != null) {\r
-                    return true;\r
-                  }\r
-                }\r
-              }\r
-            }\r
-            break;\r
-          case ENTITY_FIELDS:\r
-            if (selectedFields != null)\r
-              j = selectedFields.iterator();\r
-            else\r
-              j = anEntity.getFields().iterator();\r
-\r
-            while (j.hasNext()) {\r
-              String field = anEntity.getValue( (String) j.next());\r
-\r
-              if (exactMatch) {\r
-                if (field != null && regularExpression.isMatch(field)) {\r
-                  return true;\r
-                }\r
-              }\r
-              else {\r
-                if (field != null && regularExpression.getMatch(field) != null) {\r
-                  return true;\r
-                }\r
-              }\r
-            }\r
-        }\r
-      }\r
-      catch (Throwable t) {\r
-      }\r
-      return false;\r
-    }\r
-  }\r
-\r
+/*
+ * Copyright (C) 2001, 2002 The Mir-coders group
+ *
+ * This file is part of Mir.
+ *
+ * Mir is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * Mir is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Mir; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ * In addition, as a special exception, The Mir-coders gives permission to link
+ * the code of this program with  any library licensed under the Apache Software License,
+ * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
+ * (or with modified versions of the above that use the same license as the above),
+ * and distribute linked combinations including the two.  You must obey the
+ * GNU General Public License in all respects for all of the code used other than
+ * the above mentioned libraries.  If you modify this file, you may extend this
+ * exception to your version of the file, but you are not obligated to do so.
+ * If you do not wish to do so, delete this exception statement from your version.
+ */
+
+package mircoders.localizer.basic;
+
+import gnu.regexp.RE;
+
+import java.util.Arrays;
+import java.util.Iterator;
+import java.util.List;
+
+import mir.entity.Entity;
+import mir.session.Request;
+import mir.util.InternetFunctions;
+import mircoders.localizer.MirAntiAbuseFilterType;
+
+
+/**
+ * <p>Title: </p>
+ * <p>Description: </p>
+ * <p>Copyright: Copyright (c) 2003</p>
+ * <p>Company: </p>
+ * @author not attributable
+ * @version 1.0
+ */
+
+public class MirBasicAntiAbuseFilterTypes {
+  private MirBasicAntiAbuseFilterTypes() {
+  }
+
+  public static abstract class BasicFilterType implements MirAntiAbuseFilterType {
+    private String name;
+
+    public BasicFilterType(String aName) {
+      name = aName;
+    }
+
+    public String getName() {
+      return name;
+    }
+  }
+
+  /**
+   * A basic ip filter. Supports x.x.x.x, x.x.x.x/x and x.x.x.x/x.x.x.x expressions.
+   *
+   * <p>Title: </p>
+   * <p>Description: </p>
+   * <p>Copyright: Copyright (c) 2003</p>
+   * <p>Company: </p>
+   * @author not attributable
+   * @version 1.0
+   */
+
+  public static class IPFilter extends BasicFilterType {
+    public IPFilter(String aName) {
+      super(aName);
+    }
+
+    public boolean validate(String anExpression) {
+      try {
+        InternetFunctions.isIpAddressInNetwork("1.1.1.1", anExpression);
+        return true;
+      }
+      catch (Throwable t) {
+        return false;
+      }
+    };
+
+    public boolean test(String anExpression, Entity anEntity, Request aRequest) {
+      try {
+        return InternetFunctions.isIpAddressInNetwork(aRequest.getHeader("ip"), anExpression);
+      }
+      catch (Throwable t) {
+        return false;
+      }
+    };
+  }
+
+  /**
+   * A regular expression filter.
+   *
+   * <p>Title: </p>
+   * <p>Description: </p>
+   * <p>Copyright: Copyright (c) 2003</p>
+   * <p>Company: </p>
+   * @author not attributable
+   * @version 1.0
+   */
+
+  public static class RegularExpressionFilter extends BasicFilterType {
+    private boolean exactMatch;
+    private boolean caseSensitive;
+    private int fieldKind;
+    private List selectedFields;
+
+    public static final int ENTITY_FIELDS = 0;
+    public static final int REQUEST_HEADERS = 2;
+
+    public RegularExpressionFilter(String aName) {
+      this(aName, false, false, null);
+    }
+
+    public RegularExpressionFilter(String aName, boolean aCaseSensitive, boolean anExactMatch, String[] aSelectedFields) {
+      this (aName, aCaseSensitive, anExactMatch, ENTITY_FIELDS, aSelectedFields);
+    }
+
+    public RegularExpressionFilter(String aName, boolean aCaseSensitive, boolean anExactMatch, int aFieldKind, String[] aSelectedFields) {
+      super(aName);
+
+      fieldKind = aFieldKind;
+
+      caseSensitive = aCaseSensitive;
+      exactMatch = anExactMatch;
+      if (aSelectedFields==null)
+        selectedFields = null;
+      else
+        selectedFields = Arrays.asList(aSelectedFields);
+    }
+
+    public boolean validate(String anExpression) {
+      try {
+        new RE(anExpression);
+        return true;
+      }
+      catch (Throwable t) {
+        return false;
+      }
+    };
+
+    public boolean test(String anExpression, Entity anEntity, Request aRequest) {
+      try {
+        Iterator j;
+        int flags = 0;
+
+        if (caseSensitive)
+          // TODO jlint says this operator is useless
+          flags |= RE.REG_ICASE;
+
+        RE regularExpression = new RE(anExpression, RE.REG_ICASE);
+
+        switch (fieldKind) {
+          case REQUEST_HEADERS:
+            if (selectedFields != null) {
+              j = selectedFields.iterator();
+
+              while (j.hasNext()) {
+                String field = aRequest.getHeader( (String) j.next());
+
+                if (exactMatch) {
+                  if (field != null && regularExpression.isMatch(field)) {
+                    return true;
+                  }
+                }
+                else {
+                  if (field != null && regularExpression.getMatch(field) != null) {
+                    return true;
+                  }
+                }
+              }
+            }
+            break;
+          case ENTITY_FIELDS:
+            if (selectedFields != null)
+              j = selectedFields.iterator();
+            else
+              j = anEntity.getFields().iterator();
+
+            while (j.hasNext()) {
+              String field = anEntity.getValue( (String) j.next());
+
+              if (exactMatch) {
+                if (field != null && regularExpression.isMatch(field)) {
+                  return true;
+                }
+              }
+              else {
+                if (field != null && regularExpression.getMatch(field) != null) {
+                  return true;
+                }
+              }
+            }
+        }
+      }
+      catch (Throwable t) {
+      }
+      return false;
+    }
+  }
+
 }
\ No newline at end of file