uk.ac.ebi.metabolights.validate.ValidatorMetabolightsUser.java Source code

Introduction

Here is the source code for uk.ac.ebi.metabolights.validate.ValidatorMetabolightsUser.java

Source

/*
 * EBI MetaboLights - http://www.ebi.ac.uk/metabolights
 * Cheminformatics and Metabolism group
 *
 * European Bioinformatics Institute (EMBL-EBI), European Molecular Biology Laboratory, Wellcome Trust Genome Campus, Hinxton, Cambridge CB10 1SD, United Kingdom
 *
 * Last modified: 9/24/12 12:40 PM
 * Modified by:   conesa
 *
 *
 * , EMBL, European Bioinformatics Institute, 2014.
 *
 * 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 uk.ac.ebi.metabolights.validate;

import org.apache.commons.lang.StringUtils;
import org.springframework.validation.Errors;
import org.springframework.validation.ValidationUtils;
import org.springframework.validation.Validator;
import uk.ac.ebi.metabolights.model.MetabolightsUser;
import uk.ac.ebi.metabolights.service.EmailService;

/**
 * Validator for validation of (form) submission of user account details.
 * The error codes refer to the properties file. 
 * @author markr
 */
public class ValidatorMetabolightsUser implements Validator {

    public final static int MIN_PASSWORD_LEN = 6;
    public static final int ORCID_DIGITS_COUNT = 16;
    //public final static int MIN_USERNAME_LEN=3;

    /**
     * Validation for {@link uk.ac.ebi.metabolights.model.MetabolightsUser MetabolightsUser}, 
     * looking at required fields, email being likely, minimum/maximum field lengths.
     * 
     */
    @Override
    public void validate(Object obj, Errors e) {

        MetabolightsUser user = (MetabolightsUser) obj;

        // Required fields
        // :( not so nice to hard code attribute names here as Strings.. ah, Joy of Spring.
        ValidationUtils.rejectIfEmptyOrWhitespace(e, "firstName", "NotEmpty.metabolightsUser.firstName");
        ValidationUtils.rejectIfEmptyOrWhitespace(e, "lastName", "NotEmpty.metabolightsUser.lastName");
        //ValidationUtils.rejectIfEmptyOrWhitespace(e, "userName", "NotEmpty.metabolightsUser.userName");
        ValidationUtils.rejectIfEmptyOrWhitespace(e, "dbPassword", "NotEmpty.metabolightsUser.dbPassword");
        ValidationUtils.rejectIfEmptyOrWhitespace(e, "userVerifyDbPassword",
                "NotEmpty.metabolightsUser.userVerifyDbPassword");
        ValidationUtils.rejectIfEmptyOrWhitespace(e, "email", "NotEmpty.metabolightsUser.email");
        ValidationUtils.rejectIfEmptyOrWhitespace(e, "affiliation", "NotEmpty.metabolightsUser.affiliation");
        ValidationUtils.rejectIfEmptyOrWhitespace(e, "affiliationUrl", "NotEmpty.metabolightsUser.affiliationUrl");
        ValidationUtils.rejectIfEmptyOrWhitespace(e, "address", "NotEmpty.metabolightsUser.address");
        ValidationUtils.rejectIfEmptyOrWhitespace(e, "apiToken", "NotEmpty.metabolightsUser.apiToken");

        // Check email valid pattern (TODO: better use regex)
        if (e.getFieldError("email") == null)
            if (!EmailService.isValidEmailAddress(user.getEmail()))
                e.rejectValue("email", "Email.metabolightsUser.email");

        if (e.getFieldError("dbPassword") == null) {
            // Check two provided passwords match (prevent typo)
            if (!(user.getDbPassword().equals(user.getUserVerifyDbPassword())))
                e.rejectValue("dbPassword", "Match.metabolightsUser.passwords");
            // Check minimum size password
            else if (user.getDbPassword().length() < MIN_PASSWORD_LEN) {
                e.rejectValue("dbPassword", "Size.metabolightsUser.password");
            }
        }

        if (!user.getOrcId().equals("")) {

            String validation = validateORCID(user.getOrcId());

            if (validation != null) {
                e.rejectValue("orcid", null, validation);
            }

        }
    }

    public static String validateORCID(String formattedOrcid) {

        String cleanOrcid = formattedOrcidToNumbers(formattedOrcid);

        // Size should be 16
        if (cleanOrcid.length() != ORCID_DIGITS_COUNT) {
            return "ORCID doesn't seem to be valid. It must be 16 digits length (hyphens not included in the count).";
        }

        if (!StringUtils.isNumeric(cleanOrcid.substring(0, ORCID_DIGITS_COUNT - 1))) {
            return "ORCID doesn't seem to be valid. It must have 15 digits + 1(char)(hyphens not included in the count).";
        }

        return checkOrcid(cleanOrcid);

    }

    public static String checkOrcid(String cleanOrcid) {
        int total = 0;
        for (int i = 0; i < cleanOrcid.length() - 1; i++) {
            int digit = Character.getNumericValue(cleanOrcid.charAt(i));
            total = (total + digit) * 2;
        }
        int remainder = total % 11;
        int result = (12 - remainder) % 11;
        String expectedCheckDigit = result == 10 ? "X" : String.valueOf(result);

        // If last digit does not match...
        if (!cleanOrcid.endsWith(expectedCheckDigit)) {
            return "ORCID doesn't seem to be valid. It doesn't pass the checksum calculations.";
        }

        return null;

    }

    public static String formattedOrcidToNumbers(String formattedOrcid) {
        return formattedOrcid.replace("-", "");
    }

    @Override
    public boolean supports(Class<?> c) {
        return MetabolightsUser.class.equals(c);
    }
}