--- /dev/null
+/*-\r
+ * ================================================================================\r
+ * ECOMP Portal\r
+ * ================================================================================\r
+ * Copyright (C) 2017 AT&T Intellectual Property\r
+ * ================================================================================\r
+ * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ * \r
+ * http://www.apache.org/licenses/LICENSE-2.0\r
+ * \r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ * ================================================================================\r
+ */\r
+package org.openecomp.portalapp.util;\r
+\r
+import java.util.Enumeration;\r
+import java.util.HashMap;\r
+import java.util.HashSet;\r
+import java.util.Iterator;\r
+import java.util.List;\r
+import java.util.Set;\r
+import java.util.UUID;\r
+\r
+import javax.servlet.ServletContext;\r
+import javax.servlet.http.HttpServletRequest;\r
+import javax.servlet.http.HttpSession;\r
+\r
+import org.openecomp.portalapp.portal.domain.EPRole;\r
+import org.openecomp.portalapp.portal.domain.EPUser;\r
+import org.openecomp.portalapp.portal.domain.EPUserApp;\r
+import org.openecomp.portalapp.portal.utils.EcompPortalUtils;\r
+import org.openecomp.portalsdk.core.domain.RoleFunction;\r
+import org.openecomp.portalsdk.core.exception.SessionExpiredException;\r
+import org.openecomp.portalsdk.core.lm.FusionLicenseManager;\r
+import org.openecomp.portalsdk.core.logging.logic.EELFLoggerDelegate;\r
+import org.openecomp.portalsdk.core.menu.MenuBuilder;\r
+import org.openecomp.portalsdk.core.service.DataAccessService;\r
+import org.openecomp.portalsdk.core.util.SystemProperties;\r
+import org.openecomp.portalsdk.core.web.support.AppUtils;\r
+import org.springframework.beans.factory.annotation.Autowired;\r
+\r
+public class EPUserUtils {\r
+\r
+ private static EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(EPUserUtils.class);\r
+\r
+ private final static Long ACCOUNT_ADMIN_ROLE_ID = 999L;\r
+\r
+ public static final String ALL_ROLE_FUNCTIONS = "allRoleFunctions";\r
+\r
+ private static DataAccessService dataAccessService;\r
+\r
+ /**\r
+ * Gets the EPUser object from the session.\r
+ * \r
+ * @param request\r
+ * HttpServletRequest\r
+ * @return EPUser object that was created upon login\r
+ * @throws SessionExpiredException\r
+ * if no session exists.\r
+ */\r
+ public static EPUser getUserSession(HttpServletRequest request) {\r
+ HttpSession session = AppUtils.getSession(request);\r
+ if (session == null)\r
+ throw new SessionExpiredException();\r
+ return (EPUser) session.getAttribute(SystemProperties.getProperty(SystemProperties.USER_ATTRIBUTE_NAME));\r
+ }\r
+\r
+ /**\r
+ * Establishes the user's portal session\r
+ * \r
+ * @param request\r
+ * HttpServletRequest\r
+ * @param user\r
+ * EPUser\r
+ * @param applicationMenuData\r
+ * Menu data\r
+ * @param businessDirectMenuData\r
+ * Menu data\r
+ * @param loginMethod_ignored\r
+ * How the user authenticated; ignored\r
+ * @param allRoleFunctions\r
+ * Set of user's roles\r
+ */\r
+ @SuppressWarnings("rawtypes")\r
+ public static void setUserSession(HttpServletRequest request, EPUser user, Set applicationMenuData,\r
+ Set businessDirectMenuData, String loginMethod_ignored, List<RoleFunction> allRoleFunctions) {\r
+ HttpSession session = request.getSession(true);\r
+\r
+ // clear the current user session to avoid any conflicts\r
+ EPUserUtils.clearUserSession(request);\r
+ session.setAttribute(SystemProperties.getProperty(SystemProperties.USER_ATTRIBUTE_NAME), user);\r
+\r
+ getAllRoleFunctions(allRoleFunctions, session);\r
+\r
+ getRoleFunctions(request);\r
+\r
+ // truncate the role (and therefore the role function) data to save\r
+ // memory in the session\r
+ user.setEPRoles(null);\r
+ session.setAttribute(SystemProperties.getProperty(SystemProperties.USER_NAME), user.getFullName());\r
+\r
+ ServletContext context = session.getServletContext();\r
+ int licenseVerificationFlag = 3;\r
+ try {\r
+ licenseVerificationFlag = (Integer) context.getAttribute("licenseVerification");\r
+ } catch (Exception e) {\r
+ logger.error(EELFLoggerDelegate.errorLogger, "setUserSession failed to get licenseVerification attribute",\r
+ e);\r
+ }\r
+ switch (licenseVerificationFlag) {\r
+ case FusionLicenseManager.DEVELOPER_LICENSE:\r
+ session.setAttribute(SystemProperties.getProperty(SystemProperties.APP_DISPLAY_NAME),\r
+ "My Portal [Development Version]");\r
+ break;\r
+ case FusionLicenseManager.EXPIRED_LICENSE:\r
+ session.setAttribute(SystemProperties.getProperty(SystemProperties.APP_DISPLAY_NAME),\r
+ "My Portal [LICENSE EXPIRED]");\r
+ break;\r
+ case FusionLicenseManager.VALID_LICENSE:\r
+ session.setAttribute(SystemProperties.getProperty(SystemProperties.APP_DISPLAY_NAME), "My Portal");\r
+ break;\r
+ default:\r
+ session.setAttribute(SystemProperties.getProperty(SystemProperties.APP_DISPLAY_NAME),\r
+ "My Portal [INVALID LICENSE]");\r
+ break;\r
+ }\r
+\r
+ session.setAttribute(SystemProperties.getProperty(SystemProperties.APPLICATION_MENU_ATTRIBUTE_NAME),\r
+ MenuBuilder.filterMenu(applicationMenuData, request));\r
+ session.setAttribute(SystemProperties.getProperty(SystemProperties.BUSINESS_DIRECT_MENU_ATTRIBUTE_NAME),\r
+ MenuBuilder.filterMenu(businessDirectMenuData, request));\r
+ }\r
+\r
+ /**\r
+ * Creates a set of role function names and stores the set as a session\r
+ * attribute.\r
+ * \r
+ * @param allRoleFunctions\r
+ * List of role functions.\r
+ * @param session\r
+ * HttpSession\r
+ */\r
+ private static void getAllRoleFunctions(List<RoleFunction> allRoleFunctions, HttpSession session) {\r
+ if (allRoleFunctions == null)\r
+ return;\r
+ Set<String> roleFnSet = new HashSet<String>();\r
+ for (RoleFunction roleFn : allRoleFunctions)\r
+ roleFnSet.add(roleFn.getCode());\r
+ session.setAttribute(ALL_ROLE_FUNCTIONS, roleFnSet);\r
+ }\r
+\r
+ /**\r
+ * Removes all stored attributes from the user's session\r
+ * \r
+ * @param request\r
+ * HttpServletRequest\r
+ * @throws SessionExpiredException\r
+ * if no session exists\r
+ */\r
+ private static void clearUserSession(HttpServletRequest request) {\r
+ HttpSession session = AppUtils.getSession(request);\r
+ if (session == null)\r
+ throw new SessionExpiredException();\r
+\r
+ // removes all stored attributes from the current user's session\r
+ session.removeAttribute(SystemProperties.getProperty(SystemProperties.USER_ATTRIBUTE_NAME));\r
+ session.removeAttribute(SystemProperties.getProperty(SystemProperties.APPLICATION_MENU_ATTRIBUTE_NAME));\r
+ session.removeAttribute(SystemProperties.getProperty(SystemProperties.BUSINESS_DIRECT_MENU_ATTRIBUTE_NAME));\r
+ session.removeAttribute(SystemProperties.getProperty(SystemProperties.ROLES_ATTRIBUTE_NAME));\r
+ session.removeAttribute(SystemProperties.getProperty(SystemProperties.ROLE_FUNCTIONS_ATTRIBUTE_NAME));\r
+ }\r
+\r
+ /**\r
+ * Builds a set of role functions and sets a session attribute with it.\r
+ * \r
+ * @param request\r
+ * HttpServletRequest\r
+ * @return Set of role functions that was built.\r
+ */\r
+ @SuppressWarnings({ "rawtypes", "unchecked" })\r
+ private static Set getRoleFunctions(HttpServletRequest request) {\r
+ HashSet roleFunctions = null;\r
+\r
+ HttpSession session = request.getSession();\r
+ roleFunctions = (HashSet) session\r
+ .getAttribute(SystemProperties.getProperty(SystemProperties.ROLE_FUNCTIONS_ATTRIBUTE_NAME));\r
+\r
+ if (roleFunctions == null) {\r
+ HashMap roles = getRoles(request);\r
+ roleFunctions = new HashSet();\r
+\r
+ Iterator i = roles.keySet().iterator();\r
+\r
+ while (i.hasNext()) {\r
+ Long roleKey = (Long) i.next();\r
+ EPRole role = (EPRole) roles.get(roleKey);\r
+\r
+ Iterator j = role.getRoleFunctions().iterator();\r
+\r
+ while (j.hasNext()) {\r
+ RoleFunction function = (RoleFunction) j.next();\r
+ roleFunctions.add(function.getCode());\r
+ }\r
+ }\r
+\r
+ session.setAttribute(SystemProperties.getProperty(SystemProperties.ROLE_FUNCTIONS_ATTRIBUTE_NAME),\r
+ roleFunctions);\r
+ }\r
+\r
+ return roleFunctions;\r
+ }\r
+\r
+ /**\r
+ * Gets role information from the user session, in the cached user object.\r
+ * As a side effect sets a session variable with the roles.\r
+ * \r
+ * @param request\r
+ * HttpServletRequest\r
+ * @return Map of role ID to role object\r
+ */\r
+ @SuppressWarnings("rawtypes")\r
+ private static HashMap getRoles(HttpServletRequest request) {\r
+ HashMap roles = null;\r
+\r
+ HttpSession session = AppUtils.getSession(request);\r
+ roles = (HashMap) session.getAttribute(SystemProperties.getProperty(SystemProperties.ROLES_ATTRIBUTE_NAME));\r
+\r
+ // if roles are not already cached, let's grab them from the user\r
+ // session\r
+ if (roles == null) {\r
+ EPUser user = getUserSession(request);\r
+\r
+ // get all user roles (including the tree of child roles)\r
+ roles = getAllUserRoles(user);\r
+\r
+ session.setAttribute(SystemProperties.getProperty(SystemProperties.ROLES_ATTRIBUTE_NAME), roles);\r
+ }\r
+\r
+ return roles;\r
+ }\r
+\r
+ /**\r
+ * Builds a map of role ID to role object.\r
+ * \r
+ * @param user\r
+ * EPUser\r
+ * @return Map of role ID to role object\r
+ */\r
+ @SuppressWarnings({ "rawtypes", "unchecked" })\r
+ private static HashMap getAllUserRoles(EPUser user) {\r
+ HashMap roles = new HashMap();\r
+ Iterator i = user.getEPRoles().iterator();\r
+\r
+ while (i.hasNext()) {\r
+ EPRole role = (EPRole) i.next();\r
+\r
+ if (role.getActive()) {\r
+ roles.put(role.getId(), role);\r
+\r
+ // let's take a recursive trip down the tree to add all child\r
+ // roles\r
+ addChildRoles(role, roles);\r
+ }\r
+ }\r
+\r
+ // Additionally; the account admin role is overloaded between ecomp\r
+ // portal and partners; lets also include that\r
+ Iterator<EPUserApp> appRolesIterator = user.getEPUserApps().iterator();\r
+ while (appRolesIterator.hasNext()) {\r
+ EPRole role = (EPRole) appRolesIterator.next().getRole();\r
+\r
+ if (role.getActive() && role.getId().equals(ACCOUNT_ADMIN_ROLE_ID)) {\r
+ roles.put(role.getId(), role);\r
+\r
+ // let's take a recursive trip down the tree to add all child\r
+ // roles\r
+ addChildRoles(role, roles);\r
+ }\r
+ }\r
+\r
+ return roles;\r
+ }\r
+\r
+ /**\r
+ * Adds all child roles of the specified role to the map of roles.\r
+ * \r
+ * @param role\r
+ * EPRole\r
+ * @param roles\r
+ * Maps role id to role object\r
+ */\r
+ @SuppressWarnings({ "rawtypes", "unchecked" })\r
+ private static void addChildRoles(EPRole role, HashMap roles) {\r
+ Set childRoles = role.getChildRoles();\r
+\r
+ if (childRoles != null && childRoles.size() > 0) {\r
+ Iterator j = childRoles.iterator();\r
+ while (j.hasNext()) {\r
+ EPRole childRole = (EPRole) j.next();\r
+\r
+ if (childRole.getActive()) {\r
+ roles.put(childRole.getId(), childRole);\r
+\r
+ addChildRoles(childRole, roles);\r
+ }\r
+ }\r
+ }\r
+\r
+ }\r
+\r
+ public static boolean hasRole(EPUser user, String roleKey) {\r
+ return getAllUserRoles(user).keySet().contains(new Long(roleKey));\r
+ }\r
+\r
+ public static DataAccessService getDataAccessService() {\r
+ return dataAccessService;\r
+ }\r
+\r
+ @Autowired\r
+ public void setDataAccessService(DataAccessService dataAccessService) {\r
+ EPUserUtils.dataAccessService = dataAccessService;\r
+ }\r
+\r
+ /**\r
+ * Gets the user's ID from the user object in the session\r
+ * \r
+ * @param request\r
+ * HttpServletRequest\r
+ * @return Integer ID of current user\r
+ */\r
+ public static int getUserId(HttpServletRequest request) {\r
+ return getUserIdAsLong(request).intValue();\r
+ }\r
+\r
+ /**\r
+ * Gets the user's ID from the user object in the session\r
+ * \r
+ * @param request\r
+ * HttpServletREquest\r
+ * @return Long ID of current user\r
+ */\r
+ public static Long getUserIdAsLong(HttpServletRequest request) {\r
+ Long userId = new Long(SystemProperties.getProperty(SystemProperties.APPLICATION_USER_ID));\r
+ if (request != null) {\r
+ if (getUserSession(request) != null) {\r
+ userId = getUserSession(request).getId();\r
+ }\r
+ }\r
+ return userId;\r
+ }\r
+\r
+ /**\r
+ * Gets the request ID from the request.\r
+ * \r
+ * @param request\r
+ * HttpServletRequest\r
+ * @return Request ID\r
+ */\r
+ public static String getRequestId(HttpServletRequest request) {\r
+ Enumeration<String> headerNames = request.getHeaderNames();\r
+\r
+ String requestId = "";\r
+ try {\r
+ while (headerNames.hasMoreElements()) {\r
+ String headerName = (String) headerNames.nextElement();\r
+ logger.debug(EELFLoggerDelegate.debugLogger,\r
+ "One header is " + headerName + " : " + request.getHeader(headerName));\r
+ if (headerName.equalsIgnoreCase(SystemProperties.ECOMP_REQUEST_ID)) {\r
+ requestId = request.getHeader(headerName);\r
+ break;\r
+ }\r
+ }\r
+ } catch (Exception e) {\r
+ logger.error(EELFLoggerDelegate.errorLogger, "HEADER!!!! Exception : " + EcompPortalUtils.getStackTrace(e));\r
+ }\r
+\r
+ return (requestId.isEmpty() ? UUID.randomUUID().toString() : requestId);\r
+ }\r
+\r
+ /**\r
+ * Gets the full URL from the request.\r
+ * \r
+ * @param request\r
+ * HttpServletRequest\r
+ * @return Full URL\r
+ */\r
+ public static String getFullURL(HttpServletRequest request) {\r
+ if (request != null) {\r
+ StringBuffer requestURL = request.getRequestURL();\r
+ String queryString = request.getQueryString();\r
+\r
+ if (queryString == null) {\r
+ return requestURL.toString();\r
+ } else {\r
+ return requestURL.append('?').append(queryString).toString();\r
+ }\r
+ }\r
+ return "";\r
+ }\r
+\r
+}\r
Code Review / portal.git / blobdiff