org.eclipse.sw360.portal.users.UserPortletUtils.java Source code

Introduction

Here is the source code for org.eclipse.sw360.portal.users.UserPortletUtils.java

Source

/*
 * Copyright Siemens AG, 2013-2018. Part of the SW360 Portal Project.
 *
 * SPDX-License-Identifier: EPL-1.0
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.eclipse.sw360.portal.users;

import com.liferay.portal.NoSuchUserException;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.search.Indexer;
import com.liferay.portal.kernel.search.IndexerRegistryUtil;
import com.liferay.portal.kernel.workflow.WorkflowConstants;
import com.liferay.portal.model.Role;
import com.liferay.portal.model.User;
import com.liferay.portal.service.*;
import com.liferay.portal.service.persistence.RoleUtil;
import org.eclipse.sw360.portal.common.ErrorMessages;
import org.apache.log4j.Logger;

import javax.portlet.PortletRequest;
import javax.servlet.http.HttpServletRequest;
import java.util.Optional;
import java.util.function.Consumer;

import static com.google.common.base.Strings.isNullOrEmpty;

/**
 * @author alex.borodin@evosoft.com
 */
public class UserPortletUtils {
    private static final Logger log = Logger.getLogger(UserPortletUtils.class);

    private UserPortletUtils() {
        // Utility class with only static functions
    }

    public static User addLiferayUser(HttpServletRequest request, String firstName, String lastName,
            String emailAddress, String organizationName, String roleName, boolean male, String externalId,
            String password, boolean passwordEncrypted, boolean activateImmediately)
            throws SystemException, PortalException {
        HttpServletRequestAdapter requestAdapter = new HttpServletRequestAdapter(request);
        return addLiferayUser(requestAdapter, firstName, lastName, emailAddress, organizationName, roleName, male,
                externalId, password, passwordEncrypted, activateImmediately);
    }

    public static User addLiferayUser(PortletRequest request, String firstName, String lastName,
            String emailAddress, String organizationName, String roleName, boolean male, String externalId,
            String password, boolean passwordEncrypted, boolean activateImmediately)
            throws SystemException, PortalException {
        PortletRequestAdapter requestAdapter = new PortletRequestAdapter(request);
        return addLiferayUser(requestAdapter, firstName, lastName, emailAddress, organizationName, roleName, male,
                externalId, password, passwordEncrypted, activateImmediately);
    }

    private static User addLiferayUser(RequestAdapter requestAdapter, String firstName, String lastName,
            String emailAddress, String organizationName, String roleName, boolean male, String externalId,
            String password, boolean passwordEncrypted, boolean activateImmediately)
            throws SystemException, PortalException {
        long companyId = requestAdapter.getCompanyId();

        long organizationId = OrganizationLocalServiceUtil.getOrganizationId(companyId, organizationName);
        final Role role = RoleLocalServiceUtil.getRole(companyId, roleName);
        long roleId = role.getRoleId();

        try {
            if (userAlreadyExists(requestAdapter.getErrorMessagesConsumer(), emailAddress, externalId, externalId,
                    companyId)) {
                return null;
            }
        } catch (PortalException | SystemException e) {
            log.error(e);
            // won't try to create user if even checking for existing user failed
            return null;
        }

        try {
            long[] roleIds = roleId == 0 ? new long[] {} : new long[] { roleId };
            long[] organizationIds = organizationId == 0 ? new long[] {} : new long[] { organizationId };
            long[] userGroupIds = null;
            Optional<ServiceContext> serviceContextOpt = requestAdapter.getServiceContext();
            final ServiceContext serviceContext;
            if (!serviceContextOpt.isPresent()) {
                return null;
            } else {
                serviceContext = serviceContextOpt.get();
            }
            User defaultUser = UserLocalServiceUtil.loadGetDefaultUser(companyId);
            User user = UserLocalServiceUtil.addUser(defaultUser.getUserId()/*creator*/, companyId,
                    false, /*autoPassword*/
                    password, password, false, /*autoScreenName*/
                    externalId, emailAddress, 0/*facebookId*/, externalId/*openId*/, defaultUser.getLocale(),
                    firstName, ""/*middleName*/, lastName, 0/*prefixId*/, 0/*suffixId*/, male, 4/*birthdayMonth*/,
                    12/*birthdayDay*/, 1959/*birthdayYear*/, ""/*jobTitle*/, null/*groupIds*/, organizationIds,
                    roleIds, userGroupIds, false/*sendEmail*/, serviceContext);
            user.setPasswordReset(false);

            if (passwordEncrypted) {
                user.setPassword(password);
                user.setPasswordEncrypted(true);
            }

            RoleUtil.addUser(role.getRoleId(), user.getUserId());
            UserLocalServiceUtil.updateUser(user);
            RoleLocalServiceUtil.updateRole(role);

            UserLocalServiceUtil.updateStatus(user.getUserId(),
                    activateImmediately ? WorkflowConstants.STATUS_APPROVED : WorkflowConstants.STATUS_INACTIVE,
                    serviceContext);
            Indexer indexer = IndexerRegistryUtil.getIndexer(User.class);
            indexer.reindex(user);
            return user;
        } catch (PortalException | SystemException e) {
            log.error(e);
            return null;
        }
    }

    private static boolean userAlreadyExists(Consumer<String> errorMessageConsumer, String emailAddress,
            String externalId, String screenName, long companyId) throws PortalException, SystemException {
        boolean sameEmailExists = userByFieldExists(emailAddress, UserLocalServiceUtil::getUserByEmailAddress,
                companyId);
        boolean sameScreenNameExists = userByFieldExists(screenName, UserLocalServiceUtil::getUserByScreenName,
                companyId);
        boolean sameExternalIdExists = userByFieldExists(externalId, UserLocalServiceUtil::getUserByOpenId,
                companyId);
        boolean alreadyExists = sameScreenNameExists || sameEmailExists || sameExternalIdExists;

        if (alreadyExists) {
            String errorMessage;
            if (sameScreenNameExists) {
                errorMessage = ErrorMessages.FULL_NAME_ALREADY_EXISTS;
            } else if (sameEmailExists) {
                errorMessage = ErrorMessages.EMAIL_ALREADY_EXISTS;
            } else {
                errorMessage = ErrorMessages.EXTERNAL_ID_ALREADY_EXISTS;
            }
            log.info(errorMessage);
            errorMessageConsumer.accept(errorMessage);
        }
        return alreadyExists;
    }

    private static boolean userByFieldExists(String searchParameter, UserSearchFunction searchFunction,
            long companyId) throws PortalException, SystemException {
        try {
            searchFunction.apply(companyId, searchParameter);
        } catch (NoSuchUserException nsue) {
            return false;
        }
        return true;
    }

    @FunctionalInterface
    interface UserSearchFunction {
        User apply(long companyId, String searchParameter) throws PortalException, SystemException;
    }
}