2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
21 package org.openecomp.sdc.common.util;
23 import com.google.common.base.CharMatcher;
24 import org.apache.commons.lang3.StringEscapeUtils;
25 import org.apache.commons.lang3.StringUtils;
26 import org.apache.commons.lang3.math.NumberUtils;
27 import org.apache.commons.lang3.text.WordUtils;
28 import org.apache.commons.validator.routines.UrlValidator;
29 import org.jsoup.Jsoup;
30 import org.jsoup.helper.StringUtil;
31 import org.jsoup.safety.Whitelist;
33 import java.util.Arrays;
34 import java.util.HashSet;
35 import java.util.LinkedHashSet;
36 import java.util.List;
38 import java.util.regex.Pattern;
40 public class ValidationUtils {
41 public final static Integer COMPONENT_NAME_MAX_LENGTH = 1024;
42 public final static Pattern COMPONENT_NAME_PATTERN = Pattern
43 .compile("^[\\w][\\w \\.\\-\\_\\:\\+]{0," + (COMPONENT_NAME_MAX_LENGTH-1) + "}$");
44 public final static Integer ADDITIONAL_INFORMATION_KEY_MAX_LENGTH = 50;
45 public final static Pattern ADDITIONAL_INFORMATION_KEY_PATTERN = Pattern
46 .compile("^[\\w\\s\\.\\-\\_]{1," + COMPONENT_NAME_MAX_LENGTH + "}$");
47 public final static Integer RSI_NAME_MAX_LENGTH = 1024;
48 public final static Pattern RSI_NAME_PATTERN = Pattern
49 .compile("^[\\w \\s\\.\\-\\_\\:\\+]{1," + RSI_NAME_MAX_LENGTH + "}$");
50 public final static Integer COMMENT_MAX_LENGTH = 256;
52 public final static Integer ICON_MAX_LENGTH = 25;
53 public final static Pattern ICON_PATTERN = Pattern.compile("^[\\w\\-]{1," + ICON_MAX_LENGTH + "}$");
54 public final static Integer PROJECT_CODE_MAX_LEGTH = 50;
55 public final static Pattern PROJECT_CODE_PATTERN = Pattern.compile("^[\\s\\w_.-]{5,50}$");
57 // USER_ID format : aannnX (where a=a-z or A-Z, n=0-9, and X=a-z,A-Z, or 0-9)
58 public final static Integer CONNTACT_ID_MAX_LENGTH = 50;
59 // public final static Pattern CONTACT_ID_PATTERN = Pattern
60 // .compile("[mM]{1}[0-9]{5}|[a-zA-Z]{2}[0-9]{4}|[a-zA-Z]{2}[0-9]{3}[a-zA-Z]{1}");
61 public final static Pattern CONTACT_ID_PATTERN = Pattern.compile("^[\\s\\w_.-]{1,50}$");
62 public final static Pattern OCTET_PATTERN = Pattern.compile("%[a-fA-F0-9]{2}");
63 public final static Pattern NONE_UTF8_PATTERN = Pattern.compile("[^\\x00-\\x7F]+");
64 public final static Pattern URL_INVALIDE_PATTERN = Pattern.compile("[,#?&@$<>~^`\\\\\\[\\]{}|\")(*!+=;%]+");// ,#?&@$<>~^`\\[]{}|")(*!
66 public final static Pattern ENGLISH_PATTERN = Pattern.compile("^[\\p{Graph}\\x20]+$");
67 public final static Integer COMPONENT_DESCRIPTION_MAX_LENGTH = 1024;
68 public final static Integer SERVICE_TYPE_MAX_LENGTH = 400;
69 public final static Integer SERVICE_ROLE_MAX_LENGTH = 400;
71 public final static Integer TAG_MAX_LENGTH = 1024;
72 public final static Integer TAG_LIST_MAX_LENGTH = 1024;
73 public final static Integer VENDOR_NAME_MAX_LENGTH = 60;
74 public final static Pattern VENDOR_NAME_PATTERN = Pattern
75 .compile("^[\\x20-\\x21\\x23-\\x29\\x2B-\\x2E\\x30-\\x39\\x3B\\x3D\\x40-\\x5B\\x5D-\\x7B\\x7D-\\xFF]+$");
76 public final static Integer VENDOR_RELEASE_MAX_LENGTH = 25;
77 public final static Pattern VENDOR_RELEASE_PATTERN = Pattern
78 .compile("^[\\x20-\\x21\\x23-\\x29\\x2B-\\x2E\\x30-\\x39\\x3B\\x3D\\x40-\\x5B\\x5D-\\x7B\\x7D-\\xFF]+$");
79 public final static Integer RESOURCE_VENDOR_MODEL_NUMBER_MAX_LENGTH = 65;
81 public final static Pattern CLEAN_FILENAME_PATTERN = Pattern.compile("[\\x00-\\x1f\\x80-\\x9f\\x5c/<?>\\*:|\"/]+");
83 public final static Pattern DASH_PATTERN = Pattern.compile("[-]+");
84 public final static Pattern UNDERSCORE_PATTERN = Pattern.compile("[_]+");
85 public final static Pattern PLUS_PATTERN = Pattern.compile("[+]+");
86 public final static Pattern SPACE_PATTERN = Pattern.compile("[ ]+");
87 public final static Pattern AMP_PATTERN = Pattern.compile("[&]+");
88 public final static Pattern DOT_PATTERN = Pattern.compile("[\\.]+");
89 public final static Pattern APOST_PATTERN = Pattern.compile("[']+");
90 public final static Pattern HASHTAG_PATTERN = Pattern.compile("[#]+");
91 public final static Pattern EQUAL_PATTERN = Pattern.compile("[=]+");
92 public final static Pattern COLON_PATTERN = Pattern.compile("[:]+");
93 public final static Pattern AT_PATTERN = Pattern.compile("[@]+");
94 public final static Pattern AND_PATTERN = Pattern.compile(" [aA][Nn][Dd] ");
95 public final static Set<String> CATEGORY_CONJUNCTIONS = new HashSet<String>(
96 Arrays.asList("of", "to", "for", "as", "a", "an", "the"));
98 public final static Pattern COST_PATTERN = Pattern.compile("^[0-9]{1,5}\\.[0-9]{1,3}$");
99 public final static Pattern ARTIFACT_LABEL_PATTERN = Pattern.compile("^[a-zA-Z0-9 \\-+]+$");
100 public final static Integer ARTIFACT_LABEL_LENGTH = 255;
101 public final static Pattern ARTIFACT_DISPLAY_NAME_PATTERN = Pattern.compile("^[a-zA-Z0-9][a-zA-Z0-9 &\\.'#=:@_\\-+]+$");
102 public final static Pattern CATEGORY_LABEL_PATTERN = Pattern.compile("^[a-zA-Z0-9][a-zA-Z0-9 &\\.'#=:@_\\-+]+$");
103 public final static Integer CATEGORY_LABEL_MIN_LENGTH = 4;
104 public final static Integer CATEGORY_LABEL_MAX_LENGTH = 25;
106 public final static Pattern COMPONENT_NAME_DELIMETER_PATTERN = Pattern.compile("[\\.\\-\\_]+");
107 public final static Pattern COMPONENT_INCTANCE_NAME_DELIMETER_PATTERN = Pattern.compile("[\\.\\-]+");
108 public final static Pattern PRODUCT_NAME_DELIMETER_PATTERN = Pattern.compile("[\\.\\-\\_&=#@':\\[\\]\\+]+");
109 public final static Integer CONSUMER_NAME_MAX_LENGTH = 255;
110 // public final static Pattern CONSUMER_NAME_PATTERN =
111 // Pattern.compile("^[\\w]{1}?[\\w\\.\\-]{0," + CONSUMER_NAME_MAX_LENGTH +
113 public final static Pattern CONSUMER_NAME_PATTERN = Pattern.compile("^[\\w]+[\\w\\.\\-]*$");
114 public final static Integer CONSUMER_SALT_LENGTH = 32;
115 public final static Integer CONSUMER_PASSWORD_LENGTH = 64;
116 public final static Pattern CONSUMER_PASS_SALT_PATTERN = Pattern.compile("^[a-z0-9]+$");
117 public final static Pattern FLOAT_PATTERN = Pattern.compile("^[\\d]+[\\.]{1}[\\d]+$");
118 public final static Pattern CERTIFIED_VERSION_PATTERN = Pattern.compile("^[1-9][0-9]*\\.0$");
119 public final static Pattern MINOR_VERSION_PATTERN = Pattern.compile("^0\\.[1-9][0-9]*$");
120 public final static Pattern TAGS_PATTERN = Pattern.compile("<[^><]*>");
122 public final static Integer ARTIFACT_NAME_LENGTH = 255;
123 public final static Integer API_URL_LENGTH = 100;
124 public final static Integer ARTIFACT_DESCRIPTION_MAX_LENGTH = 256;
126 public final static Integer PRODUCT_FULL_NAME_MIN_LENGTH = 4;
127 public final static Integer PRODUCT_FULL_NAME_MAX_LENGTH = 100;
128 public static final Integer FORWARDING_PATH_NAME_MAX_LENGTH = 100;
129 public final static Pattern FORWARDING_PATH_NAME_PATTERN = Pattern.compile("^[\\w][\\w \\.\\-\\_\\:\\+]{0," + (FORWARDING_PATH_NAME_MAX_LENGTH-1) + "}$");
131 public final static Integer POLICY_MAX_LENGTH = 1024;
132 public final static Pattern POLICY_NAME_PATTERN = Pattern
133 .compile("^[\\w][\\w \\.\\-\\_\\:\\+]{0," + (POLICY_MAX_LENGTH-1) + "}$");
135 public static boolean validateArtifactLabel(String label) {
136 return ARTIFACT_LABEL_PATTERN.matcher(label).matches();
139 public static boolean validateArtifactDisplayName(String displayName) {
140 return ARTIFACT_DISPLAY_NAME_PATTERN.matcher(displayName).matches();
143 public static boolean validateCategoryDisplayNameFormat(String label) {
146 label = label.trim();
147 res = CATEGORY_LABEL_PATTERN.matcher(label).matches();
152 public static String normalizeCategoryName4Display(String str) {
155 str = DASH_PATTERN.matcher(str).replaceAll("-");
156 str = UNDERSCORE_PATTERN.matcher(str).replaceAll("_");
157 str = AMP_PATTERN.matcher(str).replaceAll("&");
158 str = PLUS_PATTERN.matcher(str).replaceAll("+");
159 str = DOT_PATTERN.matcher(str).replaceAll(".");
160 str = APOST_PATTERN.matcher(str).replaceAll("'");
161 str = HASHTAG_PATTERN.matcher(str).replaceAll("#");
162 str = EQUAL_PATTERN.matcher(str).replaceAll("=");
163 str = COLON_PATTERN.matcher(str).replaceAll(":");
164 str = AT_PATTERN.matcher(str).replaceAll("@");
165 str = normaliseWhitespace(str);
166 str = AND_PATTERN.matcher(str).replaceAll(" & ");
169 StringBuilder sb = new StringBuilder();
170 String[] split = str.split(" ");
171 for (int i = 0; i < split.length; i++) {
172 String splitted = split[i];
173 String lowerCase = splitted.toLowerCase();
174 // BANK OF AMERICA --> BANK of AMERICA ("of" is lowercased), but
175 // OF BANK OF AMERICA --> OF BANK of AMERICA (first "OF" is not
176 // lowercased because it's first word)
177 // Agreed with Ella, 26/11/15
178 if ((i > 0) && CATEGORY_CONJUNCTIONS.contains(lowerCase)) {
179 sb.append(lowerCase);
181 sb.append(WordUtils.capitalize(splitted));
185 str = sb.toString().trim();
190 public static String normalizeCategoryName4Uniqueness(String str) {
191 return str.toLowerCase();
194 public static boolean validateCategoryDisplayNameLength(String label) {
195 return (label != null && label.length() >= CATEGORY_LABEL_MIN_LENGTH
196 && label.length() <= CATEGORY_LABEL_MAX_LENGTH);
199 public static boolean validateProductFullNameLength(String fullName) {
200 return (fullName != null && fullName.length() >= PRODUCT_FULL_NAME_MIN_LENGTH
201 && fullName.length() <= PRODUCT_FULL_NAME_MAX_LENGTH);
204 public static boolean validateArtifactLabelLength(String label) {
205 return label.length() > 0 && label.length() <= ARTIFACT_LABEL_LENGTH;
208 public static boolean validateResourceInstanceNameLength(String resourceInstanceName) {
209 return resourceInstanceName.length() <= RSI_NAME_MAX_LENGTH;
212 public static boolean validateResourceInstanceName(String resourceInstanceName) {
213 return RSI_NAME_PATTERN.matcher(resourceInstanceName).matches();
216 public static boolean validateUrlLength(String url) {
217 return url.length() <= API_URL_LENGTH;
220 public static boolean validateArtifactNameLength(String artifactName) {
221 return (artifactName.length() <= ARTIFACT_NAME_LENGTH && artifactName.length() > 0);
224 public static boolean validateComponentNamePattern(String componentName) {
225 return COMPONENT_NAME_PATTERN.matcher(componentName).matches();
228 public static boolean validateComponentNameLength(String componentName) {
229 return componentName.length() <= COMPONENT_NAME_MAX_LENGTH;
232 public static boolean validateIcon(String icon) {
233 return ICON_PATTERN.matcher(icon).matches();
236 public static boolean validateIconLength(String icon) {
237 return icon.length() <= ICON_MAX_LENGTH;
240 public static boolean validateProjectCode(String projectCode) {
241 return PROJECT_CODE_PATTERN.matcher(projectCode).matches();
244 public static boolean validateProjectCodeLegth(String projectCode) {
245 return projectCode.length() <= PROJECT_CODE_MAX_LEGTH;
248 public static boolean validateContactId(String contactId) {
249 return CONTACT_ID_PATTERN.matcher(contactId).matches();
252 public static boolean validateCost(String cost) {
253 return COST_PATTERN.matcher(cost).matches();
256 public static String removeHtmlTags(String str) {
257 return Jsoup.clean(str, Whitelist.none());
260 public static String removeAllTags(String htmlText) {
262 String stripped = TAGS_PATTERN.matcher(htmlText).replaceAll("").trim();
266 public static String normaliseWhitespace(String str) {
267 return StringUtil.normaliseWhitespace(str);
270 public static String stripOctets(String str) {
271 return OCTET_PATTERN.matcher(str).replaceAll("");
274 public static String removeNoneUtf8Chars(String input) {
275 return NONE_UTF8_PATTERN.matcher(input).replaceAll("");
278 public static boolean validateIsEnglish(String input) {
279 return ENGLISH_PATTERN.matcher(input).matches();
282 public static boolean validateIsAscii(String input) {
284 boolean isAscii = CharMatcher.ASCII.matchesAllOf(input);
289 public static String convertHtmlTagsToEntities(String input) {
290 return StringEscapeUtils.escapeHtml4(input);
293 public static List<String> removeDuplicateFromList(List<String> list) {
294 Set<String> hs = new LinkedHashSet<>(list);
301 public static boolean validateTagLength(String tag) {
303 return tag.length() <= TAG_MAX_LENGTH;
308 public static boolean validateTagListLength(int tagListLength) {
309 return tagListLength <= TAG_LIST_MAX_LENGTH;
312 public static boolean validateDescriptionLength(String description) {
313 return description.length() <= COMPONENT_DESCRIPTION_MAX_LENGTH;
316 public static boolean validateStringNotEmpty(String value) {
317 if ((value == null) || (value.isEmpty())) {
323 public static boolean validateListNotEmpty(List<?> list) {
324 if ((list == null) || (list.isEmpty())) {
330 public static boolean validateVendorName(String vendorName) {
331 return VENDOR_NAME_PATTERN.matcher(vendorName).matches();
334 public static boolean validateVendorNameLength(String vendorName) {
335 return vendorName.length() <= VENDOR_NAME_MAX_LENGTH;
338 public static boolean validateResourceVendorModelNumberLength(String resourceVendorModelNumber) {
339 return resourceVendorModelNumber.length() <= RESOURCE_VENDOR_MODEL_NUMBER_MAX_LENGTH;
342 public static boolean validateVendorRelease(String vendorRelease) {
343 return VENDOR_RELEASE_PATTERN.matcher(vendorRelease).matches();
346 public static boolean validateVendorReleaseLength(String vendorRelease) {
347 return vendorRelease.length() <= VENDOR_RELEASE_MAX_LENGTH;
350 public static boolean validateServiceTypeLength(String serviceType) {
351 return serviceType.length() <= SERVICE_TYPE_MAX_LENGTH;
354 public static boolean validateServiceRoleLength(String serviceRole) {
355 return serviceRole.length() <= SERVICE_ROLE_MAX_LENGTH;
360 public static boolean hasBeenCertified(String version) {
361 return NumberUtils.toDouble(version) >= 1;
364 public static String normaliseComponentName(String name) {
365 String[] split = splitComponentName(name);
366 StringBuffer sb = new StringBuffer();
367 for (String splitElement : split) {
368 sb.append(splitElement);
370 return sb.toString();
374 public static String normalizeComponentInstanceName(String name) {
375 String[] split = splitComponentInstanceName(name);
376 StringBuffer sb = new StringBuffer();
377 for (String splitElement : split) {
378 sb.append(splitElement);
380 return sb.toString();
384 private static String[] splitComponentName(String name) {
385 String normalizedName = name.toLowerCase();
386 normalizedName = COMPONENT_NAME_DELIMETER_PATTERN.matcher(normalizedName).replaceAll(" ");
387 String[] split = normalizedName.split(" ");
391 private static String[] splitComponentInstanceName(String name) {
392 String normalizedName = name.toLowerCase();
393 normalizedName = COMPONENT_INCTANCE_NAME_DELIMETER_PATTERN.matcher(normalizedName).replaceAll(" ");
394 String[] split = normalizedName.split(" ");
398 public static String convertToSystemName(String name) {
399 String[] split = splitComponentName(name);
400 StringBuffer sb = new StringBuffer();
401 for (String splitElement : split) {
402 String capitalize = WordUtils.capitalize(splitElement);
403 sb.append(capitalize);
405 return sb.toString();
408 public static String normalizeFileName(String filename) {
409 // String[] split = filename.split(Pattern.quote(File.separator));
412 // name = split[split.length - 1];
413 return cleanFileName(filename);
417 private static String cleanFileName(String str) {
418 str = CLEAN_FILENAME_PATTERN.matcher(str).replaceAll("");
419 str = normaliseWhitespace(str);
420 str = SPACE_PATTERN.matcher(str).replaceAll("-");
421 str = DASH_PATTERN.matcher(str).replaceAll("-");
422 str = StringUtils.strip(str, "-_ .");
427 public static boolean validateUrl(String url) {
429 UrlValidator urlValidator = new UrlValidator();
430 if (!urlValidator.isValid(url)) {
433 if (NONE_UTF8_PATTERN.matcher(url).find()) {
437 if (URL_INVALIDE_PATTERN.matcher(url).find()) {
444 public static String cleanArtifactDisplayName(String strIn) {
445 String str = DASH_PATTERN.matcher(strIn).replaceAll("-");
446 str = UNDERSCORE_PATTERN.matcher(str).replaceAll("_");
447 str = PLUS_PATTERN.matcher(str).replaceAll("+");
448 str = normaliseWhitespace(str);
450 // str = str.replaceAll(" ", "");
455 public static String normalizeArtifactLabel(String strIn) {
457 String str = DASH_PATTERN.matcher(strIn).replaceAll("");
458 str = UNDERSCORE_PATTERN.matcher(str).replaceAll("");
459 str = PLUS_PATTERN.matcher(str).replaceAll("");
460 str = SPACE_PATTERN.matcher(str).replaceAll("");
461 str = DOT_PATTERN.matcher(str).replaceAll("");
462 str = str.toLowerCase();
467 public static boolean validateAdditionalInformationKeyName(String str) {
468 return ADDITIONAL_INFORMATION_KEY_PATTERN.matcher(str).matches();
471 public static String normalizeAdditionalInformation(String str) {
473 str = DASH_PATTERN.matcher(str).replaceAll("-");
474 str = UNDERSCORE_PATTERN.matcher(str).replaceAll("_");
475 str = normaliseWhitespace(str);
480 public static boolean validateLength(String str, int length) {
484 return str.length() <= length;
487 public static boolean validateConsumerName(String consumerName) {
488 return CONSUMER_NAME_PATTERN.matcher(consumerName).matches();
491 public static boolean isUTF8Str(String str) {
492 if (NONE_UTF8_PATTERN.matcher(str).find()) {
498 public static boolean validateConsumerPassSalt(String consumerSalt) {
499 return CONSUMER_PASS_SALT_PATTERN.matcher(consumerSalt).matches();
502 public static boolean isFloatNumber(String number) {
503 return FLOAT_PATTERN.matcher(number).matches();
506 public static boolean validateCertifiedVersion(String version) {
507 return (version != null && CERTIFIED_VERSION_PATTERN.matcher(version).matches());
510 public static boolean validateMinorVersion(String version) {
511 return (version != null && MINOR_VERSION_PATTERN.matcher(version).matches());
514 public static String normaliseProductName(String name) {
515 String[] split = splitComponentName(PRODUCT_NAME_DELIMETER_PATTERN, name);
516 StringBuffer sb = new StringBuffer();
517 for (String splitElement : split) {
518 sb.append(splitElement);
520 return sb.toString();
524 private static String[] splitComponentName(Pattern pattern, String name) {
525 String normalizedName = name.toLowerCase();
526 normalizedName = pattern.matcher(normalizedName).replaceAll(" ");
527 String[] split = normalizedName.split(" ");
531 public static String removeHtmlTagsOnly(String htmlText) {
532 String stripped = HtmlCleaner.stripHtml(htmlText, false);
536 public static boolean validateForwardingPathNamePattern(String forwardingPathName) {
537 return FORWARDING_PATH_NAME_PATTERN.matcher(forwardingPathName).matches();