OO-1829 replace email validation with version from apache commons

pom.xml

@@ -1699,6 +1699,12 @@
 			<artifactId>commons-collections</artifactId>
 			<version>3.2.1</version>
 		</dependency>
+		<dependency>
+			<!-- Used by email address validator -->
+			<groupId>commons-validator</groupId>
+			<artifactId>commons-validator</artifactId>
+			<version>1.5.0</version>
+		</dependency>
 		<dependency>
 			<!-- Used by at least commons-fileupload, webdriver -->
 			<groupId>commons-io</groupId>

src/main/java/org/olat/core/util/mail/EmailAddressValidator.java

@@ -19,147 +19,27 @@
  */
 package org.olat.core.util.mail;
 
-import java.util.regex.Pattern;
+import org.apache.commons.validator.routines.EmailValidator;
 
 /**
  * Description:<br>
  * This validator checks if a given email address is valid against the RFC
- * specs. This code has been written and published by Les Hazlewood.
- * <p>
- * Please note the copyright information below
- * <p>
- * @see http://www.leshazlewood.com/?p=5 for more information.
+ * specs. 
  * <P>
  * Initial Date: 12.11.2009 <br>
  * 
  * @author gnaegi
  */
 public class EmailAddressValidator {
-
-	/*
-	 * Copyright 2008 Les Hazlewood
-	 * 
-	 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
-	 * use this file except in compliance with the License. You may obtain a copy
-	 * of the License at
-	 * 
-	 * http://www.apache.org/licenses/LICENSE-2.0
-	 * 
-	 * Unless required by applicable law or agreed to in writing, software
-	 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-	 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-	 * License for the specific language governing permissions and limitations
-	 * under the License.
-	 */
-
-	/**
-	 * This constant states that domain literals are allowed in the email address,
-	 * e.g.:
-	 * 
-	 * <p>
-	 * <tt>someone@[192.168.1.100]</tt> or <br/>
-	 * <tt>john.doe@[23:33:A2:22:16:1F]</tt> or <br/>
-	 * <tt>me@[my computer]</tt>
-	 * </p>
-	 * 
-	 * <p>
-	 * The RFC says these are valid email addresses, but most people don't like
-	 * allowing them. If you don't want to allow them, and only want to allow
-	 * valid domain names (<a href="http://www.ietf.org/rfc/rfc1035.txt">RFC
-	 * 1035</a>, x.y.z.com, etc), change this constant to <tt>false</tt>.
-	 * 
-	 * <p>
-	 * Its default value is <tt>true</tt> to remain RFC 2822 compliant, but you
-	 * should set it depending on what you need for your application.
-	 */
-	private static final boolean ALLOW_DOMAIN_LITERALS = false; // not allowed in OLAT
-
-	/**
-	 * This contstant states that quoted identifiers are allowed (using quotes and
-	 * angle brackets around the raw address) are allowed, e.g.:
-	 * 
-	 * <p>
-	 * <tt>"John Smith" &lt;john.smith@somewhere.com&gt;</tt>
-	 * 
-	 * <p>
-	 * The RFC says this is a valid mailbox. If you don't want to allow this,
-	 * because for example, you only want users to enter in a raw address (
-	 * <tt>john.smith@somewhere.com</tt> - no quotes or angle brackets), then
-	 * change this constant to <tt>false</tt>.
-	 * 
-	 * <p>
-	 * Its default value is <tt>true</tt> to remain RFC 2822 compliant, but you
-	 * should set it depending on what you need for your application.
-	 */
-	private static final boolean ALLOW_QUOTED_IDENTIFIERS = false; // not allowed in OLAT
-
-	// RFC 2822 2.2.2 Structured Header Field Bodies
-	private static final String wsp = "[ \\t]"; // space or tab
-	private static final String fwsp = wsp + "*";
-
-	// RFC 2822 3.2.1 Primitive tokens
-	private static final String dquote = "\\\"";
-	// ASCII Control characters excluding white space:
-	private static final String noWsCtl = "\\x01-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F";
-	// all ASCII characters except CR and LF:
-	private static final String asciiText = "[\\x01-\\x09\\x0B\\x0C\\x0E-\\x7F]";
-
-	// RFC 2822 3.2.2 Quoted characters:
-	// single backslash followed by a text char
-	private static final String quotedPair = "(\\\\" + asciiText + ")";
-
-	// RFC 2822 3.2.4 Atom:
-	private static final String atext = "[a-zA-Z0-9\\!\\#\\$\\%\\&\\'\\*\\+\\-\\/\\=\\?\\^\\_\\`\\{\\|\\}\\~]";
-	private static final String atom = fwsp + atext + "+" + fwsp;
-	private static final String dotAtomText = atext + "+" + "(" + "\\." + atext + "+)*";
-	private static final String dotAtom = fwsp + "(" + dotAtomText + ")" + fwsp;
-
-	// RFC 2822 3.2.5 Quoted strings:
-	// noWsCtl and the rest of ASCII except the doublequote and backslash
-	// characters:
-	private static final String qtext = "[" + noWsCtl + "\\x21\\x23-\\x5B\\x5D-\\x7E]";
-	private static final String qcontent = "(" + qtext + "|" + quotedPair + ")";
-	private static final String quotedString = dquote + "(" + fwsp + qcontent + ")*" + fwsp + dquote;
-
-	// RFC 2822 3.2.6 Miscellaneous tokens
-	private static final String word = "((" + atom + ")|(" + quotedString + "))";
-	private static final String phrase = word + "+"; // one or more words.
-
-	// RFC 1035 tokens for domain names:
-	private static final String letter = "[a-zA-Z]";
-	private static final String letDig = "[a-zA-Z0-9]";
-	private static final String letDigHyp = "[a-zA-Z0-9-]";
-	private static final String rfcLabel = letDig + "(" + letDigHyp + "{0,61}" + letDig + ")?";
-	private static final String rfc1035DomainName = rfcLabel + "(\\." + rfcLabel + ")*\\." + letter + "{2,6}";
-
-	// RFC 2822 3.4 Address specification
-	// domain text - non white space controls and the rest of ASCII chars not
-	// including [, ], or \:
-	private static final String dtext = "[" + noWsCtl + "\\x21-\\x5A\\x5E-\\x7E]";
-	private static final String dcontent = dtext + "|" + quotedPair;
-	private static final String domainLiteral = "\\[" + "(" + fwsp + dcontent + "+)*" + fwsp + "\\]";
-	private static final String rfc2822Domain = "(" + dotAtom + "|" + domainLiteral + ")";
-
-	private static final String domain = ALLOW_DOMAIN_LITERALS ? rfc2822Domain : rfc1035DomainName;
-
-	private static final String localPart = "((" + dotAtom + ")|(" + quotedString + "))";
-	private static final String addrSpec = localPart + "@" + domain;
-	private static final String angleAddr = "<" + addrSpec + ">";
-	private static final String nameAddr = "(" + phrase + ")?" + fwsp + angleAddr;
-	private static final String mailbox = nameAddr + "|" + addrSpec;
-
-	// now compile a pattern for efficient re-use:
-	// if we're allowing quoted identifiers or not:
-	private static final String patternString = ALLOW_QUOTED_IDENTIFIERS ? mailbox : addrSpec;
-	public static final Pattern VALID_PATTERN = Pattern.compile(patternString);
-
+	private static final EmailValidator validator = EmailValidator.getInstance();
 	/**
 	 * Check if the given mail address is valid according to RFC specifications.
 	 * @param mailAddress
 	 * @return true: valid email address; false: not a valid email address
 	 */
 	public static boolean isValidEmailAddress(String mailAddress) {
-		if (mailAddress == null) return false;
-		return VALID_PATTERN.matcher( mailAddress ).matches();
+		// Validate an email address
+		boolean isAddressValid = validator.isValid(mailAddress);
+		return isAddressValid;
 	}
 }

src/test/java/org/olat/core/util/mail/EmailAddressValidatorTest.java

+/**
+ * <a href="http://www.openolat.org">
+ * OpenOLAT - Online Learning and Training</a><br>
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License"); <br>
+ * you may not use this file except in compliance with the License.<br>
+ * You may obtain a copy of the License at the
+ * <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache homepage</a>
+ * <p>
+ * Unless required by applicable law or agreed to in writing,<br>
+ * software distributed under the License is distributed on an "AS IS" BASIS, <br>
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
+ * See the License for the specific language governing permissions and <br>
+ * limitations under the License.
+ * <p>
+ * Initial code contributed and copyrighted by<br>
+ * frentix GmbH, http://www.frentix.com
+ * <p>
+ */
+package org.olat.core.util.mail;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+import org.olat.core.util.mail.EmailAddressValidator;
+
+/**
+ * Description:<br>
+ * This test case tests the mail address validator
+ * 
+ * <P>
+ * Initial Date:  14.07.2009 <br>
+ * @author gnaegi
+ */
+@RunWith(JUnit4.class)
+public class EmailAddressValidatorTest {
+
+	@Test public void testPlainText() {
+		// correct stuff
+		Assert.assertTrue(EmailAddressValidator.isValidEmailAddress("contact@openolat.org"));
+		Assert.assertTrue(EmailAddressValidator.isValidEmailAddress("hello.world@crazy.world"));
+		
+		// following did not work with implementation in OpenOLAT < 10.4.2
+		Assert.assertTrue(EmailAddressValidator.isValidEmailAddress("frustig.lustig@on-openolat.consulting"));
+		Assert.assertTrue(EmailAddressValidator.isValidEmailAddress("contakt@umläüte.biz"));
+		Assert.assertTrue(EmailAddressValidator.isValidEmailAddress("contakt@umläüte.biz"));
+		Assert.assertTrue(EmailAddressValidator.isValidEmailAddress("dont.knwo.what.it@means.中国"));
+		Assert.assertTrue(EmailAddressValidator.isValidEmailAddress("dont.knwo@in.рф"));
+		
+		// wrong stuff
+		Assert.assertFalse(EmailAddressValidator.isValidEmailAddress(null));
+		Assert.assertFalse(EmailAddressValidator.isValidEmailAddress(""));
+		Assert.assertFalse(EmailAddressValidator.isValidEmailAddress("asdf"));
+		Assert.assertFalse(EmailAddressValidator.isValidEmailAddress("asdf@.."));		
+		Assert.assertFalse(EmailAddressValidator.isValidEmailAddress("wrong email @ address dot com"));
+		Assert.assertFalse(EmailAddressValidator.isValidEmailAddress("email @with.blank"));
+		Assert.assertFalse(EmailAddressValidator.isValidEmailAddress("great.domain.com"));
+		Assert.assertFalse(EmailAddressValidator.isValidEmailAddress("some.thing@"));
+		
+	}
+}

src/test/java/org/olat/test/AllTestsJunit4.java

@@ -65,6 +65,7 @@ import org.junit.runners.Suite;
 	org.olat.core.util.EncoderTest.class,
 	org.olat.core.util.SimpleHtmlParserTest.class,
 	org.olat.core.util.IPUtilsTest.class,
+	org.olat.core.util.mail.EmailAddressValidatorTest.class,
 	org.olat.core.util.mail.manager.MailManagerTest.class,
 	org.olat.core.id.context.BusinessControlFactoryTest.class,
 	org.olat.core.id.context.HistoryManagerTest.class,