CommunicationsUtils.java

Go to the documentation of this file.

/*
 * Sleuth Kit Data Model
 *
 * Copyright 2020 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * 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.
 */
package org.sleuthkit.datamodel;

import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;
import org.apache.commons.lang3.StringUtils;

public final class CommunicationsUtils {

        // These symbols are allowed in dialed or written forms of phone numbers.
        // A '+' is allowed only as a leading digit and hence not inlcuded here.
        private static final Set<String> TELEPHONY_CHARS = new HashSet<>(Arrays.asList(
                        "-", "(", ")", "#", "*", ","
        ));

        private static final int MIN_PHONENUMBER_LEN = 3;

        private CommunicationsUtils() {
        }

        public static String normalizePhoneNum(String phoneNumber) throws InvalidAccountIDException {

                if (StringUtils.isEmpty(phoneNumber)) {
                        throw new InvalidAccountIDException(String.format("Input phone number is empty or null."));
                }

                if (isValidPhoneNumber(phoneNumber) == false) {
                        throw new InvalidAccountIDException(String.format("Input string is not a valid phone number: %s", phoneNumber));
                }

                String normalizedNumber = phoneNumber.trim();
                normalizedNumber = normalizedNumber.replaceAll("\\s+", ""); // remove spaces.   
                normalizedNumber = normalizedNumber.replaceAll("[\\-()]", ""); // remove parens & dashes.

                // ensure a min length
                if (normalizedNumber.length() < MIN_PHONENUMBER_LEN) {
                        throw new InvalidAccountIDException("Invalid phone number string " + phoneNumber);

                }
                return normalizedNumber;
        }

        public static String normalizeEmailAddress(String emailAddress) throws InvalidAccountIDException {

                if (StringUtils.isEmpty(emailAddress)) {
                        throw new InvalidAccountIDException(String.format("Input email address is empty or null."));
                }

                if (isValidEmailAddress(emailAddress) == false) {
                        throw new InvalidAccountIDException(String.format("Input string is not a valid email address: %s", emailAddress));
                }

                return emailAddress.toLowerCase().replace(";", "").trim();
        }

        public static boolean isValidAccountId(Account.Type accountType, String accountUniqueID) {
                if (accountType == Account.Type.PHONE) {
                        return isValidPhoneNumber(accountUniqueID);
                }
                if (accountType == Account.Type.EMAIL) {
                        return isValidEmailAddress(accountUniqueID);
                }

                return !StringUtils.isEmpty(accountUniqueID);
        }

        public static boolean isValidPhoneNumber(String phoneNum) {
                if (StringUtils.isEmpty(phoneNum)) {
                        return false;
                }

                String trimmedPhoneNum = phoneNum.trim();
                
                // A phone number may have a leading '+', special telephony chars, or digits.
                // Anything else implies an invalid phone number.
                for (int i = 0; i < trimmedPhoneNum.length(); i++) {
                        if (!((trimmedPhoneNum.charAt(i) == '+' && i == 0)              // a '+' is allowed only at the beginning
                                        || isValidPhoneChar(trimmedPhoneNum.charAt(i)))) {
                                return false;
                        }
                }

                return true;
        }

        private static boolean isValidPhoneChar(char ch) {
                return Character.isSpaceChar(ch)
                                || Character.isDigit(ch)
                                || TELEPHONY_CHARS.contains(String.valueOf(ch));
        }

        public static boolean isValidEmailAddress(String emailAddress) {
                if (StringUtils.isEmpty(emailAddress)) {
                        return false;
                }

                if (emailAddress.contains("@") == false
                                || emailAddress.contains(".") == false ) {
                        return false;
                }

                // emsure there's a username and domain 
                String[] tokens = emailAddress.split("@");
                if (tokens.length < 2
                                || StringUtils.isEmpty(tokens[0])
                                || StringUtils.isEmpty(tokens[1])) {
                        return false;
                }

                // ensure domain has name and suffix
                String[] tokens2 = tokens[1].split("\\.");
                return !(tokens2.length < 2
                                || StringUtils.isEmpty(tokens2[0])
                                || StringUtils.isEmpty(tokens2[1]));
        }
}