RegexFieldValidator.java
/*
* 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.apache.struts2.validator.validators;
import org.apache.struts2.validator.ValidationException;
import org.apache.commons.lang3.StringUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import java.util.Collection;
import java.util.Objects;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* <!-- START SNIPPET: javadoc -->
* Validates a string field using a regular expression.
* <!-- END SNIPPET: javadoc -->
*
*
* <!-- START SNIPPET: parameters -->
* <ul>
* <li>fieldName - The field name this validator is validating. Required if using Plain-Validator Syntax otherwise not required</li>
* <li>regexp - The RegExp expression</li>
* <li>caseSensitive - Boolean (Optional). Sets whether the expression should be matched against in a case-sensitive way. Default is <code>true</code>.</li>
* <li>trim - Boolean (Optional). Sets whether the expression should be trimmed before matching. Default is <code>true</code>.</li>
* <li>regexExpression - String (Optional). Defines regExp expression as an OGNL expression - will be evaluated to String</li>
* <li>caseSensitiveExpression - String (Optional). Defines caseSensitive param as an OGNL expression - will be evaluated to Boolean.</li>
* <li>trimExpression - String (Optional). Defines trim param as an OGNL expression - will be evaluated to Boolean</li>
* </ul>
*
* <p>
* You can mix normal params with expression aware params but thus was not tested
* </p>
* <!-- END SNIPPET: parameters -->
*
* <!-- START SNIPPET: parameters-warning -->
* <p>
* Do not use ${regexExpression}, ${caseSensitiveExpression} and ${trimExpression} as an expression as this will turn into infinitive loop!
* </p>
* <!-- END SNIPPET: parameters-warning -->
*
* <pre>
* <!-- START SNIPPET: example -->
* <validators>
* <!-- Plain Validator Syntax -->
* <validator type="regex">
* <param name="fieldName">myStrangePostcode</param>
* <param name="regex"><![CDATA[([aAbBcCdD][123][eEfFgG][456])]]></param>
* </validator>
*
* <!-- Field Validator Syntax -->
* <field name="myStrangePostcode">
* <field-validator type="regex">
* <param name="regex"><![CDATA[([aAbBcCdD][123][eEfFgG][456])]]></param>
* </field-validator>
* </field>
*
* <!-- Field Validator Syntax with expressions -->
* <field name="myStrangePostcode">
* <field-validator type="regex">
* <param name="regexExpression">${regexValue}</param> <!-- will be evaluated as: String getRegexValue() -->
* <param name="caseSensitiveExpression">${caseSensitiveValue}</param> <!-- will be evaluated as: boolean getCaseSensitiveValue() -->
* <param name="trimExpression">${trimValue}</param> <!-- will be evaluated as: boolean getTrimValue() -->
* </field-validator>
* </field>
* </validators>
* <!-- END SNIPPET: example -->
* </pre>
*
* @author Quake Wang
*/
public class RegexFieldValidator extends FieldValidatorSupport {
private static final Logger LOG = LogManager.getLogger(RegexFieldValidator.class);
private String regex;
private String regexExpression;
private Boolean caseSensitive = true;
private String caseSensitiveExpression = EMPTY_STRING;
private Boolean trim = true;
private String trimExpression = EMPTY_STRING;
public void validate(Object object) throws ValidationException {
String fieldName = getFieldName();
Object value = this.getFieldValue(fieldName, object);
// if there is no value - don't do comparison
// if a value is required, a required validator should be added to the field
String regexToUse = getRegex();
LOG.debug("Defined regexp as [{}]", regexToUse);
if (value == null || regexToUse == null) {
LOG.debug("Either value is empty (please use a required validator) or regex is empty");
return;
}
if (value.getClass().isArray()) {
Object[] values = (Object[]) value;
for (Object objValue: values) {
validateFieldValue(object, Objects.toString(objValue, EMPTY_STRING), regexToUse);
}
} else if (Collection.class.isAssignableFrom(value.getClass())) {
Collection values = (Collection) value;
for (Object objValue : values) {
validateFieldValue(object, Objects.toString(objValue, EMPTY_STRING), regexToUse);
}
} else {
validateFieldValue(object, Objects.toString(value, EMPTY_STRING), regexToUse);
}
}
protected void validateFieldValue(Object object, String value, String regexToUse) {
// string must not be empty
String str = value.trim();
if (str.isEmpty()) {
LOG.debug("Value is empty, please use a required validator");
return;
}
// match against expression
Pattern pattern;
if (isCaseSensitive()) {
pattern = Pattern.compile(regexToUse);
} else {
pattern = Pattern.compile(regexToUse, Pattern.CASE_INSENSITIVE);
}
String compare = value;
if (isTrimed()) {
compare = compare.trim();
}
try {
setCurrentValue(compare);
Matcher matcher = pattern.matcher(compare);
if (!matcher.matches()) {
addFieldError(fieldName, object);
}
} finally {
setCurrentValue(null);
}
}
/**
* @return Returns the regular expression to be matched.
*/
public String getRegex() {
if (StringUtils.isNotEmpty(regex)) {
return regex;
} else if (StringUtils.isNotEmpty(regexExpression)) {
return (String) parse(regexExpression, String.class);
} else {
return null;
}
}
/**
* @param regex the regular expression to be matched
*/
public void setRegex(String regex) {
this.regex = regex;
}
/**
* @param regexExpression the regular expression as an OGNL expression to be matched
*/
public void setRegexExpression(String regexExpression) {
this.regexExpression = regexExpression;
}
/**
* @return Returns whether the expression should be matched against in
* a case-sensitive way. Default is <code>true</code>.
*/
public boolean isCaseSensitive() {
if (StringUtils.isNotEmpty(caseSensitiveExpression)) {
return (Boolean) parse(caseSensitiveExpression, Boolean.class);
}
return caseSensitive;
}
/**
* @param caseSensitive whether the expression should be matched against in
* a case-sensitive way. Default is <code>true</code>.
*/
public void setCaseSensitive(Boolean caseSensitive) {
this.caseSensitive = caseSensitive;
}
/**
* @param caseSensitiveExpression Allows specify caseSensitive param as an OGNL expression
*/
public void setCaseSensitiveExpression(String caseSensitiveExpression) {
this.caseSensitiveExpression = caseSensitiveExpression;
}
/**
* @return Returns whether the expression should be trimed before matching.
* Default is <code>true</code>.
*/
public boolean isTrimed() {
if (StringUtils.isNotEmpty(trimExpression)) {
return (Boolean) parse(trimExpression, Boolean.class);
}
return trim;
}
/**
* @param trim whether the expression should be trimed before matching.
* Default is <code>true</code>.
*/
public void setTrim(Boolean trim) {
this.trim = trim;
}
/**
* Allows specify trim param as an OGNL expression
*
* @param trimExpression trim param as an OGNL expression
*/
public void setTrimExpression(String trimExpression) {
this.trimExpression = trimExpression;
}
}