* limitations under the License.
* ============LICENSE_END=========================================================
*/
-
package org.openecomp.sdc.common.util;
import com.google.common.base.CharMatcher;
-import org.apache.commons.lang3.StringEscapeUtils;
-import org.apache.commons.lang3.StringUtils;
-import org.apache.commons.lang3.math.NumberUtils;
-import org.apache.commons.lang3.text.WordUtils;
-import org.apache.commons.validator.routines.UrlValidator;
-import org.jsoup.Jsoup;
-import org.jsoup.safety.Whitelist;
-
import java.util.Arrays;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import java.util.regex.Pattern;
+import org.apache.commons.collections.CollectionUtils;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.lang3.math.NumberUtils;
+import org.apache.commons.text.StringEscapeUtils;
+import org.apache.commons.text.WordUtils;
+import org.apache.commons.validator.routines.UrlValidator;
+import org.jsoup.Jsoup;
+import org.jsoup.safety.Safelist;
public class ValidationUtils {
+
public static final Integer COMPONENT_NAME_MAX_LENGTH = 1024;
- public static final Pattern COMPONENT_NAME_PATTERN = Pattern
- .compile("^[\\w][\\w \\.\\-\\_\\:\\+]{0," + (COMPONENT_NAME_MAX_LENGTH - 1) + "}$");
+ public static final Pattern COMPONENT_NAME_PATTERN = Pattern.compile("^[\\w][\\w \\.\\-\\_\\:\\+]{0," + (COMPONENT_NAME_MAX_LENGTH - 1) + "}$");
public static final Integer ADDITIONAL_INFORMATION_KEY_MAX_LENGTH = 50;
- public static final Pattern ADDITIONAL_INFORMATION_KEY_PATTERN = Pattern
- .compile("^[\\w\\s\\.\\-\\_]{1," + COMPONENT_NAME_MAX_LENGTH + "}$");
+ public static final Pattern ADDITIONAL_INFORMATION_KEY_PATTERN = Pattern.compile("^[\\w\\s\\.\\-\\_]{1," + COMPONENT_NAME_MAX_LENGTH + "}$");
public static final Integer RSI_NAME_MAX_LENGTH = 1024;
- public static final Pattern RSI_NAME_PATTERN = Pattern
- .compile("^[\\w \\s\\.\\-\\_\\:\\+]{1," + RSI_NAME_MAX_LENGTH + "}$");
+ public static final Pattern RSI_NAME_PATTERN = Pattern.compile("^[\\w \\s\\.\\-\\_\\:\\+]{1," + RSI_NAME_MAX_LENGTH + "}$");
public static final Integer COMMENT_MAX_LENGTH = 256;
-
public static final Integer ICON_MAX_LENGTH = 25;
public static final Pattern ICON_PATTERN = Pattern.compile("^[\\w\\-]{1," + ICON_MAX_LENGTH + "}$");
public static final Integer PROJECT_CODE_MAX_LEGTH = 50;
public static final Pattern PROJECT_CODE_PATTERN = Pattern.compile("^[\\s\\w_.-]{5,50}$");
-
+ // USER_ID format : aannnX (where a=a-z or A-Z, n=0-9, and X=a-z,A-Z, or 0-9)
public static final Integer CONNTACT_ID_MAX_LENGTH = 50;
public static final Pattern CONTACT_ID_PATTERN = Pattern.compile("^[\\s\\w_.-]{1,50}$");
public static final Pattern OCTET_PATTERN = Pattern.compile("%[a-fA-F0-9]{2}");
public static final Pattern NONE_UTF8_PATTERN = Pattern.compile("[^\\x00-\\x7F]+");
- public static final Pattern URL_INVALIDE_PATTERN = Pattern.compile("[,#?&@$<>~^`\\\\\\[\\]{}|\")(*!+=;%]+"); // ,#?&@$<>~^`\\[]{}|")(*!
-
+ public static final Pattern URL_INVALIDE_PATTERN = Pattern.compile("[,#?&@$<>~^`\\\\\\[\\]{}|\")(*!+=;%]+");// ,#?&@$<>~^`\\[]{}|")(*!
public static final Pattern ENGLISH_PATTERN = Pattern.compile("^[\\p{Graph}\\x20]+$");
+ public static final Pattern COMMENT_PATTERN = Pattern.compile("^[\\u0000-\\u00BF]{1,1024}$");
+ public static final Pattern SERVICE_METADATA_PATTERN = Pattern
+ .compile("^[\\x20-\\x21\\x23-\\x29\\x2B-\\x2E\\x30-\\x39\\x3B\\x3D\\x40-\\x5B\\x5D-\\x7B\\x7D-\\xFF]{1,256}");
public static final Integer COMPONENT_DESCRIPTION_MAX_LENGTH = 1024;
- public static final Integer SERVICE_TYPE_MAX_LENGTH = 400;
- public static final Integer SERVICE_ROLE_MAX_LENGTH = 400;
-
+ public static final Integer SERVICE_TYPE_MAX_LENGTH = 256;
+ public static final Integer SERVICE_ROLE_MAX_LENGTH = 256;
+ public static final Integer SERVICE_FUNCTION_MAX_LENGTH = 256;
+ public static final Integer SERVICE_NAMING_POLICY_MAX_SIZE = 100;
public static final Integer TAG_MAX_LENGTH = 1024;
public static final Integer TAG_LIST_MAX_LENGTH = 1024;
public static final Integer VENDOR_NAME_MAX_LENGTH = 60;
public static final Pattern VENDOR_NAME_PATTERN = Pattern
- .compile("^[\\x20-\\x21\\x23-\\x29\\x2B-\\x2E\\x30-\\x39\\x3B\\x3D\\x40-\\x5B\\x5D-\\x7B\\x7D-\\xFF]+$");
+ .compile("^[\\x20-\\x21\\x23-\\x29\\x2B-\\x2E\\x30-\\x39\\x3B\\x3D\\x40-\\x5B\\x5D-\\x7B\\x7D-\\xFF]+$");
public static final Integer VENDOR_RELEASE_MAX_LENGTH = 25;
public static final Pattern VENDOR_RELEASE_PATTERN = Pattern
- .compile("^[\\x20-\\x21\\x23-\\x29\\x2B-\\x2E\\x30-\\x39\\x3B\\x3D\\x40-\\x5B\\x5D-\\x7B\\x7D-\\xFF]+$");
+ .compile("^[\\x20-\\x21\\x23-\\x29\\x2B-\\x2E\\x30-\\x39\\x3B\\x3D\\x40-\\x5B\\x5D-\\x7B\\x7D-\\xFF]+$");
public static final Integer RESOURCE_VENDOR_MODEL_NUMBER_MAX_LENGTH = 65;
-
public static final Pattern CLEAN_FILENAME_PATTERN = Pattern.compile("[\\x00-\\x1f\\x80-\\x9f\\x5c/<?>\\*:|\"/]+");
-
+ public static final Pattern YANG_MODULE_3GPP_PATTERN = Pattern.compile("^(_3gpp).*$");
public static final Pattern DASH_PATTERN = Pattern.compile("[-]+");
public static final Pattern UNDERSCORE_PATTERN = Pattern.compile("[_]+");
public static final Pattern PLUS_PATTERN = Pattern.compile("[+]+");
public static final Pattern COLON_PATTERN = Pattern.compile("[:]+");
public static final Pattern AT_PATTERN = Pattern.compile("[@]+");
public static final Pattern AND_PATTERN = Pattern.compile(" [aA][Nn][Dd] ");
- public static final Set<String> CATEGORY_CONJUNCTIONS = new HashSet<>(
- Arrays.asList("of", "to", "for", "as", "a", "an", "the"));
-
public static final Pattern COST_PATTERN = Pattern.compile("^[0-9]{1,5}\\.[0-9]{1,3}$");
- public static final Pattern ARTIFACT_LABEL_PATTERN = Pattern.compile("^[a-zA-Z0-9 \\-+]+$");
+ public static final Pattern ARTIFACT_LABEL_PATTERN = Pattern.compile("^[a-zA-Z0-9 \\-@+]+$");
public static final Integer ARTIFACT_LABEL_LENGTH = 255;
public static final Pattern ARTIFACT_DISPLAY_NAME_PATTERN = Pattern.compile("^[a-zA-Z0-9][a-zA-Z0-9 &\\.'#=:@_\\-+]+$");
public static final Pattern CATEGORY_LABEL_PATTERN = Pattern.compile("^[a-zA-Z0-9][a-zA-Z0-9 &\\.'#=:@_\\-+]+$");
public static final Integer CATEGORY_LABEL_MIN_LENGTH = 3;
public static final Integer CATEGORY_LABEL_MAX_LENGTH = 25;
-
public static final Pattern COMPONENT_NAME_DELIMETER_PATTERN = Pattern.compile("[\\.\\-\\_]+");
public static final Pattern COMPONENT_INCTANCE_NAME_DELIMETER_PATTERN = Pattern.compile("[\\.\\-]+");
public static final Pattern PRODUCT_NAME_DELIMETER_PATTERN = Pattern.compile("[\\.\\-\\_&=#@':\\[\\]\\+]+");
public static final Integer CONSUMER_NAME_MAX_LENGTH = 255;
- // public static final Pattern CONSUMER_NAME_PATTERN =
- // Pattern.compile("^[\\w]{1}?[\\w\\.\\-]{0," + CONSUMER_NAME_MAX_LENGTH +
- // "}?$");
public static final Pattern CONSUMER_NAME_PATTERN = Pattern.compile("^[\\w]+[\\w\\.\\-]*$");
public static final Integer CONSUMER_SALT_LENGTH = 32;
public static final Integer CONSUMER_PASSWORD_LENGTH = 64;
public static final Pattern CERTIFIED_VERSION_PATTERN = Pattern.compile("^[1-9][0-9]*\\.0$");
public static final Pattern MINOR_VERSION_PATTERN = Pattern.compile("^0\\.[1-9][0-9]*$");
public static final Pattern TAGS_PATTERN = Pattern.compile("<[^><]*>");
-
+ public static final Pattern TAG_PATTERN = Pattern.compile("^[\\s\\w_.-]{1,1024}$");
public static final Integer ARTIFACT_NAME_LENGTH = 255;
public static final Integer API_URL_LENGTH = 100;
public static final Integer ARTIFACT_DESCRIPTION_MAX_LENGTH = 256;
-
public static final Integer PRODUCT_FULL_NAME_MIN_LENGTH = 4;
public static final Integer PRODUCT_FULL_NAME_MAX_LENGTH = 100;
public static final Integer FORWARDING_PATH_NAME_MAX_LENGTH = 100;
- public static final Pattern FORWARDING_PATH_NAME_PATTERN = Pattern.compile("^[\\w][\\w \\.\\-\\_\\:\\+]{0," + (FORWARDING_PATH_NAME_MAX_LENGTH - 1) + "}$");
-
+ public static final Pattern FORWARDING_PATH_NAME_PATTERN = Pattern
+ .compile("^[\\w][\\w \\.\\-\\_\\:\\+]{0," + (FORWARDING_PATH_NAME_MAX_LENGTH - 1) + "}$");
public static final Integer POLICY_MAX_LENGTH = 1024;
- public static final Pattern POLICY_NAME_PATTERN = Pattern
- .compile("^[\\w][\\w \\.\\-\\_\\:\\+]{0," + (POLICY_MAX_LENGTH - 1) + "}$");
+ public static final Pattern POLICY_NAME_PATTERN = Pattern.compile("^[\\w][\\w \\.\\-\\_\\:\\+]{0," + (POLICY_MAX_LENGTH - 1) + "}$");
+ private static final Set<String> CATEGORY_CONJUNCTIONS = new HashSet<>(Arrays.asList("of", "to", "for", "as", "a", "an", "the"));
+
+ private ValidationUtils() {
+ }
public static boolean validateArtifactLabel(String label) {
return ARTIFACT_LABEL_PATTERN.matcher(label).matches();
return ARTIFACT_DISPLAY_NAME_PATTERN.matcher(displayName).matches();
}
+ public static String cleanUpText(String text) {
+ text = removeNoneUtf8Chars(text);
+ text = normaliseWhitespace(text);
+ text = stripOctets(text);
+ text = removeHtmlTagsOnly(text);
+ return text;
+ }
+
+ public static boolean validateTagPattern(String tag) {
+ return TAG_PATTERN.matcher(tag).matches();
+ }
+
+ public static boolean validateServiceMetadata(String metadataField) {
+ return SERVICE_METADATA_PATTERN.matcher(metadataField).matches();
+ }
+
+ public static boolean validateCommentPattern(String comment) {
+ return COMMENT_PATTERN.matcher(comment).matches();
+ }
+
public static boolean validateCategoryDisplayNameFormat(String label) {
boolean res = true;
if (label != null) {
str = AT_PATTERN.matcher(str).replaceAll("@");
str = normaliseWhitespace(str);
str = AND_PATTERN.matcher(str).replaceAll(" & ");
-
// Case normalizing
StringBuilder sb = new StringBuilder();
String[] split = str.split(" ");
String splitted = split[i];
String lowerCase = splitted.toLowerCase();
// BANK OF AMERICA --> BANK of AMERICA ("of" is lowercased), but
+
// OF BANK OF AMERICA --> OF BANK of AMERICA (first "OF" is not
+
// lowercased because it's first word)
+
// Agreed with Ella, 26/11/15
if ((i > 0) && CATEGORY_CONJUNCTIONS.contains(lowerCase)) {
sb.append(lowerCase);
}
public static boolean validateCategoryDisplayNameLength(String label) {
- return (label != null && label.length() >= CATEGORY_LABEL_MIN_LENGTH
- && label.length() <= CATEGORY_LABEL_MAX_LENGTH);
+ return (label != null && label.length() >= CATEGORY_LABEL_MIN_LENGTH && label.length() <= CATEGORY_LABEL_MAX_LENGTH);
}
public static boolean validateProductFullNameLength(String fullName) {
- return (fullName != null && fullName.length() >= PRODUCT_FULL_NAME_MIN_LENGTH
- && fullName.length() <= PRODUCT_FULL_NAME_MAX_LENGTH);
+ return (fullName != null && fullName.length() >= PRODUCT_FULL_NAME_MIN_LENGTH && fullName.length() <= PRODUCT_FULL_NAME_MAX_LENGTH);
}
public static boolean validateArtifactLabelLength(String label) {
}
public static boolean validateResourceInstanceNameLength(String resourceInstanceName) {
- return resourceInstanceName.length() <= RSI_NAME_MAX_LENGTH;
+ return StringUtils.isEmpty(resourceInstanceName) || resourceInstanceName.length() <= RSI_NAME_MAX_LENGTH;
}
public static boolean validateResourceInstanceName(String resourceInstanceName) {
}
public static boolean validateUrlLength(String url) {
- return url.length() <= API_URL_LENGTH;
+ return StringUtils.isEmpty(url) || url.length() <= API_URL_LENGTH;
}
public static boolean validateArtifactNameLength(String artifactName) {
}
public static boolean validateComponentNameLength(String componentName) {
- return componentName.length() <= COMPONENT_NAME_MAX_LENGTH;
+ return StringUtils.isEmpty(componentName) || componentName.length() <= COMPONENT_NAME_MAX_LENGTH;
}
public static boolean validateIcon(String icon) {
}
public static boolean validateIconLength(String icon) {
- return icon.length() <= ICON_MAX_LENGTH;
+ return StringUtils.isEmpty(icon) || icon.length() <= ICON_MAX_LENGTH;
}
public static boolean validateProjectCode(String projectCode) {
}
public static boolean validateProjectCodeLegth(String projectCode) {
- return projectCode.length() <= PROJECT_CODE_MAX_LEGTH;
+ return StringUtils.isEmpty(projectCode) || projectCode.length() <= PROJECT_CODE_MAX_LEGTH;
}
public static boolean validateContactId(String contactId) {
}
public static String removeHtmlTags(String str) {
- return Jsoup.clean(str, Whitelist.none());
+ return Jsoup.clean(str, Safelist.none());
}
public static String removeAllTags(String htmlText) {
-
return TAGS_PATTERN.matcher(htmlText).replaceAll("").trim();
}
private static void appendNormalisedWhitespace(StringBuilder accum, String string, boolean stripLeading) {
boolean lastWasWhite = false;
boolean reachedNonWhite = false;
-
int len = string.length();
int c;
for (int i = 0; i < len; i += Character.charCount(c)) {
}
public static boolean validateIsAscii(String input) {
-
- return CharMatcher.ASCII.matchesAllOf(input);
+ return CharMatcher.ascii().matchesAllOf(input);
}
public static String convertHtmlTagsToEntities(String input) {
list.clear();
list.addAll(hs);
return list;
-
}
public static boolean validateTagLength(String tag) {
}
public static boolean validateDescriptionLength(String description) {
- return description.length() <= COMPONENT_DESCRIPTION_MAX_LENGTH;
- }
-
- public static boolean validateStringNotEmpty(String value) {
- if ((value == null) || (value.isEmpty())) {
- return false;
- }
- return true;
+ return StringUtils.isEmpty(description) || description.length() <= COMPONENT_DESCRIPTION_MAX_LENGTH;
}
public static boolean validateListNotEmpty(List<?> list) {
}
public static boolean validateVendorNameLength(String vendorName) {
- return vendorName.length() <= VENDOR_NAME_MAX_LENGTH;
+ return StringUtils.isEmpty(vendorName) || vendorName.length() <= VENDOR_NAME_MAX_LENGTH;
}
public static boolean validateResourceVendorModelNumberLength(String resourceVendorModelNumber) {
- return resourceVendorModelNumber.length() <= RESOURCE_VENDOR_MODEL_NUMBER_MAX_LENGTH;
+ return StringUtils.isEmpty(resourceVendorModelNumber) || resourceVendorModelNumber.length() <= RESOURCE_VENDOR_MODEL_NUMBER_MAX_LENGTH;
}
public static boolean validateVendorRelease(String vendorRelease) {
- return VENDOR_RELEASE_PATTERN.matcher(vendorRelease).matches();
+ return StringUtils.isEmpty(vendorRelease) || VENDOR_RELEASE_PATTERN.matcher(vendorRelease).matches();
}
public static boolean validateVendorReleaseLength(String vendorRelease) {
- return vendorRelease.length() <= VENDOR_RELEASE_MAX_LENGTH;
+ return StringUtils.isEmpty(vendorRelease) || vendorRelease.length() <= VENDOR_RELEASE_MAX_LENGTH;
}
public static boolean validateServiceTypeLength(String serviceType) {
- return serviceType.length() <= SERVICE_TYPE_MAX_LENGTH;
+ return StringUtils.isEmpty(serviceType) || serviceType.length() <= SERVICE_TYPE_MAX_LENGTH;
}
public static boolean validateServiceRoleLength(String serviceRole) {
- return serviceRole.length() <= SERVICE_ROLE_MAX_LENGTH;
+ return StringUtils.isEmpty(serviceRole) || serviceRole.length() <= SERVICE_ROLE_MAX_LENGTH;
}
+ public static boolean validateServiceFunctionLength(String serviceFunction) {
+ return StringUtils.isEmpty(serviceFunction) || serviceFunction.length() <= SERVICE_FUNCTION_MAX_LENGTH;
+ }
+
+ public static boolean validateServiceNamingPolicyLength(String namingPolicy) {
+ return StringUtils.isEmpty(namingPolicy) || namingPolicy.length() <= SERVICE_NAMING_POLICY_MAX_SIZE;
+ }
public static boolean hasBeenCertified(String version) {
return NumberUtils.toDouble(version) >= 1;
sb.append(splitElement);
}
return sb.toString();
-
}
public static String normalizeComponentInstanceName(String name) {
sb.append(splitElement);
}
return sb.toString();
-
}
private static String[] splitComponentName(String name) {
}
public static String normalizeFileName(String filename) {
- // String[] split = filename.split(Pattern.quote(File.separator));
- // String name = "";
- //
- // name = split[split.length - 1];
return cleanFileName(filename);
-
}
private static String cleanFileName(String str) {
str = normaliseWhitespace(str);
str = SPACE_PATTERN.matcher(str).replaceAll("-");
str = DASH_PATTERN.matcher(str).replaceAll("-");
- str = StringUtils.strip(str, "-_ .");
-
+ if (!YANG_MODULE_3GPP_PATTERN.matcher(str).matches()) {
+ str = StringUtils.strip(str, "-_ .");
+ }
return str;
}
public static boolean validateUrl(String url) {
-
UrlValidator urlValidator = new UrlValidator();
if (!urlValidator.isValid(url)) {
return false;
if (NONE_UTF8_PATTERN.matcher(url).find()) {
return false;
}
-
if (URL_INVALIDE_PATTERN.matcher(url).find()) {
return false;
}
return true;
-
}
public static String cleanArtifactDisplayName(String strIn) {
str = PLUS_PATTERN.matcher(str).replaceAll("+");
str = normaliseWhitespace(str);
str = str.trim();
- // str = str.replaceAll(" ", "");
-
return str;
}
public static String normalizeArtifactLabel(String strIn) {
-
String str = DASH_PATTERN.matcher(strIn).replaceAll("");
str = UNDERSCORE_PATTERN.matcher(str).replaceAll("");
str = PLUS_PATTERN.matcher(str).replaceAll("");
str = SPACE_PATTERN.matcher(str).replaceAll("");
str = DOT_PATTERN.matcher(str).replaceAll("");
str = str.toLowerCase();
-
return str;
}
return (version != null && MINOR_VERSION_PATTERN.matcher(version).matches());
}
+ public static boolean validateCategoryIconNotEmpty(List<String> categoryIcons) {
+ return CollectionUtils.isEmpty(categoryIcons);
+ }
+
public static String normaliseProductName(String name) {
String[] split = splitComponentName(PRODUCT_NAME_DELIMETER_PATTERN, name);
StringBuilder sb = new StringBuilder();
sb.append(splitElement);
}
return sb.toString();
-
}
private static String[] splitComponentName(Pattern pattern, String name) {
public static boolean validateForwardingPathNamePattern(String forwardingPathName) {
return FORWARDING_PATH_NAME_PATTERN.matcher(forwardingPathName).matches();
}
+
+ public static String sanitizeInputString(String input) {
+ if (StringUtils.isNotEmpty(input)) {
+ input = ValidationUtils.removeNoneUtf8Chars(input);
+ input = ValidationUtils.removeHtmlTags(input);
+ input = ValidationUtils.normaliseWhitespace(input);
+ input = ValidationUtils.stripOctets(input);
+ }
+ return input;
+ }
}