LoginService.java

/*
Copyright (c) Microsoft Open Technologies, Inc.  All rights reserved.
 
The MIT License (MIT)
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
 */
package com.microsoftopentechnologies.azchat.web.services;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathFactory;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Service;
import org.w3c.dom.Document;

import com.microsoftopentechnologies.azchat.web.common.exceptions.AzureChatBusinessException;
import com.microsoftopentechnologies.azchat.web.common.exceptions.AzureChatException;
import com.microsoftopentechnologies.azchat.web.common.exceptions.AzureChatSystemException;
import com.microsoftopentechnologies.azchat.web.common.utils.AzureChatConstants;
import com.microsoftopentechnologies.azchat.web.common.utils.AzureChatUtils;
import com.microsoftopentechnologies.azchat.web.dao.FriendRequestDAOImpl;
import com.microsoftopentechnologies.azchat.web.dao.PreferenceMetadataDAO;
import com.microsoftopentechnologies.azchat.web.dao.ProfileImageRequestDAO;
import com.microsoftopentechnologies.azchat.web.dao.UserDAO;
import com.microsoftopentechnologies.azchat.web.dao.data.entities.sql.PreferenceMetadataEntity;
import com.microsoftopentechnologies.azchat.web.dao.data.entities.sql.UserEntity;
import com.microsoftopentechnologies.azchat.web.data.beans.BaseBean;
import com.microsoftopentechnologies.azchat.web.data.beans.UserBean;
import com.microsoftopentechnologies.azchat.web.data.beans.UserPrefBean;

/**
 * This service class provides the service methods for user login process.
 * 
 * @author Dnyaneshwar_Pawar
 *
 */
@Service
@Qualifier("loginService")
public class LoginService extends BaseServiceImpl {

	private static final Logger LOGGER = LogManager
			.getLogger(LoginService.class);

	@Autowired
	private UserDAO userDao;

	@Autowired
	private FriendRequestDAOImpl friendRequestDAOImpl;

	@Autowired
	private ProfileImageRequestDAO profileImageRequestDAO;

	@Autowired
	private PreferenceMetadataDAO preferenceMetadataDAO;

	@Autowired
	@Qualifier("contentShareService")
	private ContentShareService contentShareService;

	/**
	 * Execute Service implementation for the Login service.The switch takes
	 * action parameter coming from service calling controller which is instance
	 * of ServiceActionEnum.The actions in this method are mapped conventionally
	 * by ServiceActionEnum to execute the operation and modify the model bean.
	 * 
	 * @throws Exception
	 */
	@Override
	public BaseBean executeService(BaseBean baseBean) throws AzureChatException {
		LOGGER.info("[LoginService][executeService]          start");
		BaseBean baseBeanObj = null;
		switch (baseBean.getServiceAction()) {
		case LOGIN:
			baseBeanObj = processUserLogin((UserBean) baseBean);
			break;
		default:
			break;
		}
		LOGGER.info("[LoginService][executeService]          end");
		return baseBeanObj;
	}

	/**
	 * This method process the login user details.Fetch the logged in user
	 * information from the database.
	 * 
	 * @param loginBean
	 * @throws Exception
	 */
	private UserBean processUserLogin(UserBean userBean)
			throws AzureChatException {
		LOGGER.info("[LoginService][processLoginForm]          start");
		List<UserEntity> userEntities = null;
		populateSAMLTokenDetailsToUserBean(userBean);
		try {
			userEntities = userDao.getUserDetailsByNameIdAndIdentityProvider(
					userBean.getNameID(), userBean.getIdProvider());
			if (userEntities.size() > 0) {
				UserEntity user = userEntities.get(0);
				popuateUserDetailsToUserBean(user, userBean);
			} else {
				userBean.setNewUser(true);
				userBean.setUsrPrefList(getUserPreferences());
			}
		} catch (AzureChatBusinessException e) {
			LOGGER.error("Exception occurred while fetching user details from Azure Storage and SQL."
					+ e.getMessage());
			throw new AzureChatBusinessException(e.getMessage());
		} catch (AzureChatSystemException e) {
			LOGGER.error("Exception occurred while fetching user details from Azure Storage and SQL ."
					+ e.getMessage());
			throw new AzureChatSystemException(e.getMessage());
		} catch (Exception e) {
			LOGGER.error("Exception occurred while fetching user details from Azure SQL DB."
					+ e.getMessage());
			throw new AzureChatSystemException(
					"Exception occurred while fetching user details from AZURE SQL DB."
							+ e.getMessage());
		}

		LOGGER.info("[LoginService][processLoginForm]          end");
		return userBean;
	}

	/**
	 * This method populates the user details and user content share details to
	 * the userBean.
	 * 
	 * @param user
	 * @param userBean
	 * @throws Exception
	 */
	private void popuateUserDetailsToUserBean(UserEntity user, UserBean userBean)
			throws Exception {
		LOGGER.debug("User " + user.getFirstName() + " " + user.getLastName()
				+ " found with nameID : " + userBean.getNameID()
				+ " and Identity Provider :" + userBean.getIdProvider());
		userBean.setUserID(String.valueOf(user.getUserID()));
		userBean.setNewUser(false);
		// Set Necessary Properties in the Bean
		userBean.setPendingFriendReq(friendRequestDAOImpl
				.getPendingFriendRequestsCountForUser(userBean.getUserID()));
		userBean.setFirstName(user.getFirstName());
		userBean.setLastName(user.getLastName());
		userBean.setEmail(user.getEmailAddress());
		userBean.setCountryCD(String.valueOf(user.getPhoneCountryCode()));
		userBean.setPhoneNo(String.valueOf(user.getPhoneNumber()));
		userBean.setPhotoUrl(user.getPhotoBlobUrl()
				+ AzureChatConstants.CONSTANT_QUESTION_MARK
				+ AzureChatUtils
						.getSASUrl(AzureChatConstants.PROFILE_IMAGE_CONTAINER));
		// Fetch the content for this user
		userBean = contentShareService.getUserContent(userBean);

		LOGGER.debug("User Details : " + userBean.toString());

	}

	/**
	 * This method populates the userBean from samlToken.
	 * 
	 * @param samplToken
	 * @throws AzureChatSystemException
	 */
	private void populateSAMLTokenDetailsToUserBean(UserBean userBean)
			throws AzureChatSystemException {
		String samlToken = userBean.getSamplToken();
		LOGGER.debug("saml token : " + samlToken);
		XPath xPath = XPathFactory.newInstance().newXPath();
		try {
			Document assertionDoc = AzureChatUtils.getDocument(samlToken);
			String nameID = AzureChatUtils.getNameIDFromAssertion(xPath,
					assertionDoc);
			LOGGER.debug("	Name ID : " + nameID);
			userBean.setNameID(nameID);
			Map<String, String> claimMap = AzureChatUtils
					.getUserAttributeDetails(xPath, assertionDoc);
			if (claimMap != null && !claimMap.isEmpty()) {
				userBean.setIdProvider(claimMap
						.get(AzureChatConstants.ATTR_IDENTITY_PROVIDER));
				userBean.setEmail(claimMap
						.get(AzureChatConstants.ATTR_EMAIL_ADDRESS));
				if (claimMap.get(AzureChatConstants.ATTR_NAME) != null) {
					String[] userNameTokens = claimMap.get(
							AzureChatConstants.ATTR_NAME).split("\\s");
					if (userNameTokens != null) {
						if (userNameTokens.length >= 2) {
							userBean.setFirstName(userNameTokens[0]);
							userBean.setLastName(userNameTokens[1]);
						} else {
							userBean.setFirstName(userNameTokens[0]);
						}
					}

				}

			}
			LOGGER.debug("Claim Map : " + claimMap.toString());
		} catch (Exception e) {
			LOGGER.error("Exception occurred while parsing saml token : "
					+ e.getMessage());
			throw new AzureChatSystemException(
					"Exception occurred while parsing saml token : "
							+ e.getMessage());
		}

	}

	/**
	 * Used to get all user preferences to be selected on register page.
	 * 
	 * @return
	 * @throws AzureChatSystemException
	 */
	private List<UserPrefBean> getUserPreferences()
			throws AzureChatSystemException {
		LOGGER.info("[LoginSErvice][getUserPreferences] start");
		List<UserPrefBean> userList = new ArrayList<UserPrefBean>();
		try {
			List<PreferenceMetadataEntity> preferenceMetadataEntities = preferenceMetadataDAO
					.getPreferenceMetadataEntities();
			for (PreferenceMetadataEntity preferenceMetadataEntity : preferenceMetadataEntities) {
				userList.add(buildUserPrefBean(preferenceMetadataEntity));
			}
		} catch (Exception e) {
			LOGGER.error("Exception occurred while fetching user preference metadata from AZURE SQL DB."
					+ e.getMessage());
			throw new AzureChatSystemException(
					"Exception occurred while fetching user details from AZURE SQL DB."
							+ e.getMessage());
		}
		LOGGER.info("[LoginSErvice][getUserPreferences] end");
		return userList;
	}

	/**
	 * Used to generate UserPrefBean object from PreferenceMetadataEntity
	 * object.
	 * 
	 * @param preferenceMetadataEntity
	 * @return
	 */
	private UserPrefBean buildUserPrefBean(
			PreferenceMetadataEntity preferenceMetadataEntity) {
		UserPrefBean userPrefBean = new UserPrefBean();
		userPrefBean.setPrefDesc(preferenceMetadataEntity.getPreferenceDesc());
		return userPrefBean;
	}

}