/* * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You 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. */ package org.openstreetmap.josm.data.validation.routines; import static org.openstreetmap.josm.tools.I18n.tr; import java.util.regex.Matcher; import java.util.regex.Pattern; /** *
Perform email validations.
** This class is a Singleton; you can retrieve the instance via the getInstance() method. *
** Based on a script by Sandeep V. Tamhankar * http://javascript.internet.com *
** This implementation is not guaranteed to catch all possible errors in an email address. * For example, an address like nobody@noplace.somedog will pass validator, even though there * is no TLD "somedog" *
. * * @version $Revision: 1227719 $ $Date: 2012-01-05 18:45:51 +0100 (Thu, 05 Jan 2012) $ * @since Validator 1.4 */ public class EmailValidator extends AbstractValidator { private static final String SPECIAL_CHARS = "\\p{Cntrl}\\(\\)<>@,;:'\\\\\\\"\\.\\[\\]"; private static final String VALID_CHARS = "[^\\s" + SPECIAL_CHARS + "]"; private static final String QUOTED_USER = "(\"[^\"]*\")"; private static final String WORD = "((" + VALID_CHARS + "|')+|" + QUOTED_USER + ")"; private static final String LEGAL_ASCII_REGEX = "^\\p{ASCII}+$"; private static final String EMAIL_REGEX = "^\\s*?(.+)@(.+?)\\s*$"; private static final String IP_DOMAIN_REGEX = "^\\[(.*)\\]$"; private static final String USER_REGEX = "^\\s*" + WORD + "(\\." + WORD + ")*$"; private static final Pattern MATCH_ASCII_PATTERN = Pattern.compile(LEGAL_ASCII_REGEX); private static final Pattern EMAIL_PATTERN = Pattern.compile(EMAIL_REGEX); private static final Pattern IP_DOMAIN_PATTERN = Pattern.compile(IP_DOMAIN_REGEX); private static final Pattern USER_PATTERN = Pattern.compile(USER_REGEX); private final boolean allowLocal; /** * Singleton instance of this class, which * doesn't consider local addresses as valid. */ private static final EmailValidator EMAIL_VALIDATOR = new EmailValidator(false); /** * Singleton instance of this class, which does * consider local addresses valid. */ private static final EmailValidator EMAIL_VALIDATOR_WITH_LOCAL = new EmailValidator(true); /** * Returns the Singleton instance of this validator. * * @return singleton instance of this validator. */ public static EmailValidator getInstance() { return EMAIL_VALIDATOR; } /** * Returns the Singleton instance of this validator, * with local validation as required. * * @param allowLocal Should local addresses be considered valid? * @return singleton instance of this validator */ public static EmailValidator getInstance(boolean allowLocal) { if(allowLocal) { return EMAIL_VALIDATOR_WITH_LOCAL; } return EMAIL_VALIDATOR; } /** * Protected constructor for subclasses to use. * * @param allowLocal Should local addresses be considered valid? */ protected EmailValidator(boolean allowLocal) { super(); this.allowLocal = allowLocal; } /** *Checks if a field has a valid e-mail address.
* * @param email The value validation is being performed on. Anull
* value is considered invalid.
* @return true if the email address is valid.
*/
@Override
public boolean isValid(String email) {
if (email == null) {
return false;
}
Matcher asciiMatcher = MATCH_ASCII_PATTERN.matcher(email);
if (!asciiMatcher.matches()) {
setErrorMessage(tr("E-mail address contains non-ascii characters"));
setFix(email.replaceAll("[^\\p{ASCII}]+", ""));
return false;
}
// Check the whole email address structure
Matcher emailMatcher = EMAIL_PATTERN.matcher(email);
if (!emailMatcher.matches()) {
setErrorMessage(tr("E-mail address is invalid"));
return false;
}
if (email.endsWith(".")) {
setErrorMessage(tr("E-mail address is invalid"));
return false;
}
String username = emailMatcher.group(1);
if (!isValidUser(username)) {
setErrorMessage(tr("E-mail address contains an invalid username: {0}", username));
return false;
}
String domain = emailMatcher.group(2);
if (!isValidDomain(domain)) {
setErrorMessage(tr("E-mail address contains an invalid domain: {0}", domain));
return false;
}
return true;
}
/**
* Returns true if the domain component of an email address is valid.
*
* @param domain being validated.
* @return true if the email address's domain is valid.
*/
protected boolean isValidDomain(String domain) {
// see if domain is an IP address in brackets
Matcher ipDomainMatcher = IP_DOMAIN_PATTERN.matcher(domain);
if (ipDomainMatcher.matches()) {
InetAddressValidator inetAddressValidator =
InetAddressValidator.getInstance();
return inetAddressValidator.isValid(ipDomainMatcher.group(1));
} else {
// Domain is symbolic name
DomainValidator domainValidator =
DomainValidator.getInstance(allowLocal);
return domainValidator.isValid(domain);
}
}
/**
* Returns true if the user component of an email address is valid.
*
* @param user being validated
* @return true if the user name is valid.
*/
protected boolean isValidUser(String user) {
return USER_PATTERN.matcher(user).matches();
}
}