BaseAction.java

/**
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific language governing rights and limitations under
 * the License.
 *
 * The Original Code is OpenELIS code.
 *
 * Copyright (C) The Minnesota Department of Health.  All Rights Reserved.
 *
 * Contributor(s): CIRG, University of Washington, Seattle WA.
 * Contributor(s): ITECH, University of Washington, Seattle WA.
 */
package us.mn.state.health.lims.common.action;

import org.apache.struts.Globals;
import org.apache.struts.action.*;
import us.mn.state.health.lims.analysis.valueholder.Analysis;
import us.mn.state.health.lims.common.log.LogEvent;
import us.mn.state.health.lims.common.provider.validation.AccessionNumberValidationProvider;
import us.mn.state.health.lims.common.security.PageIdentityUtil;
import us.mn.state.health.lims.common.util.StringUtil;
import us.mn.state.health.lims.common.util.SystemConfiguration;
import us.mn.state.health.lims.common.util.resources.ResourceLocator;
import us.mn.state.health.lims.common.util.validator.ActionError;
import us.mn.state.health.lims.common.valueholder.BaseTestComparator;
import us.mn.state.health.lims.login.dao.UserModuleDAO;
import us.mn.state.health.lims.login.daoimpl.UserModuleDAOImpl;
import us.mn.state.health.lims.login.valueholder.UserSessionData;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.*;

public abstract class BaseAction extends Action implements IActionConstants {
	private static final boolean USE_PARAMETERS = true;

	protected String currentUserId;

	public BaseAction() {

	}

	public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
			throws Exception {

		// return to login page if user session is not found
		UserModuleDAO userModuleDAO = new UserModuleDAOImpl();
		if (userModuleDAO.isSessionExpired(request)) {
			ActionMessages errors = new ActionMessages();
			ActionError error = new ActionError("login.error.session.message", null, null);
			errors.add(ActionMessages.GLOBAL_MESSAGE, error);
			saveErrors(request, errors);
			return mapping.findForward(LOGIN_PAGE);
		}

		String pageSubtitle;
		String pageTitle;

		if (FWD_SUCCESS.equals(request.getParameter("forward"))) {
			setSuccessFlag(request);
		}

		currentUserId = getSysUserId(request);

		ActionForward forward = performAction(mapping, form, request, response);
		String pageTitleKey = getPageTitleKey(request, form);
		String pageSubtitleKey = getPageSubtitleKey(request, form);

		String pageTitleKeyParameter = getPageTitleKeyParameter(request, form);
		String pageSubtitleKeyParameter = getPageSubtitleKeyParameter(request, form);

		request.getSession().setAttribute(Globals.LOCALE_KEY, SystemConfiguration.getInstance().getDefaultLocale());

		if (StringUtil.isNullorNill(pageTitleKeyParameter)) {
			pageTitle = getMessageForKey(pageTitleKey);
		} else {
			pageTitle = getMessageForKey(request, pageTitleKey, pageTitleKeyParameter);
		}

		if (StringUtil.isNullorNill(pageSubtitleKeyParameter)) {
			pageSubtitle = getMessageForKey(pageSubtitleKey);
		} else {
			pageSubtitle = getMessageForKey(request, pageSubtitleKey, pageSubtitleKeyParameter);
		}

		if (null != pageTitle)
			request.setAttribute(PAGE_TITLE_KEY, pageTitle);
		if (null != pageSubtitle)
			request.setAttribute(PAGE_SUBTITLE_KEY, pageSubtitle);

		setFormAttributes(form, request);

		if (userModuleDAO.isAccountDisabled(request)) {
			ActionMessages errors = new ActionMessages();
			ActionError error = new ActionError("login.error.account.disable", null, null);
			errors.add(ActionMessages.GLOBAL_MESSAGE, error);
			saveErrors(request, errors);
			return mapping.findForward(LOGIN_PAGE);
		}

		if (userModuleDAO.isAccountLocked(request)) {
			ActionMessages errors = new ActionMessages();
			ActionError error = new ActionError("login.error.account.lock", null, null);
			errors.add(ActionMessages.GLOBAL_MESSAGE, error);
			saveErrors(request, errors);
			return mapping.findForward(LOGIN_PAGE);
		}

		if (userModuleDAO.isPasswordExpired(request)) {
			ActionMessages errors = new ActionMessages();
			ActionError error = new ActionError("login.error.password.expired", null, null);
			errors.add(ActionMessages.GLOBAL_MESSAGE, error);
			saveErrors(request, errors);
			return mapping.findForward(LOGIN_PAGE);
		}

		// uncomment to collect the actionNames
		// System.out.println("actionName: " + PageIdentityUtil.getActionName(request, USE_PARAMETERS));

		// check for user type (admin or non-admin)
		if (!userModuleDAO.isUserAdmin(request)) {
			if (SystemConfiguration.getInstance().getPermissionAgent().equals("ROLE")) {
				if (!PageIdentityUtil.isMainPage(request)) {

					@SuppressWarnings("rawtypes")
					HashSet accessMap = (HashSet) request.getSession().getAttribute(IActionConstants.PERMITTED_ACTIONS_MAP);

					if (!accessMap.contains(PageIdentityUtil.getActionName(request, USE_PARAMETERS))) {
						return handlePermissionDenied(mapping, request, userModuleDAO.isSessionExpired(request));
					}
				}
			} else {
				if (!userModuleDAO.isVerifyUserModule(request)) {
					return handlePermissionDenied(mapping, request, userModuleDAO.isSessionExpired(request));
				}
			}
		}
		userModuleDAO.setupUserSessionTimeOut(request);

		return forward;
	}

	protected boolean userHasPermissionForModule(HttpServletRequest request, String module){
		UserModuleDAO userModuleDAO = new UserModuleDAOImpl();
		if (!userModuleDAO.isUserAdmin(request) && SystemConfiguration.getInstance().getPermissionAgent().equals("ROLE")) {
				@SuppressWarnings("rawtypes")
				HashSet accessMap = (HashSet) request.getSession().getAttribute(IActionConstants.PERMITTED_ACTIONS_MAP);
				return accessMap.contains( module);
		}
		
		return true;
	}
	
	private ActionForward handlePermissionDenied(ActionMapping mapping, HttpServletRequest request, boolean sessionExpired) {
		ActionMessages errors = new ActionMessages();
		ActionError error = new ActionError("login.error.module.not.allow", null, null);
		errors.add(ActionMessages.GLOBAL_MESSAGE, error);
		saveErrors(request, errors);

		LogEvent.logInfo("BaseAction", "execute()", "======> NOT ALLOWED ACCESS TO THIS MODULE");

		return sessionExpired ? mapping.findForward(LOGIN_PAGE) : mapping.findForward(HOME_PAGE);
	}

	/**
	 * Abstract method that sub classes must implement to perform the desired
	 * action
	 */
	protected abstract ActionForward performAction(ActionMapping mapping, ActionForm form, HttpServletRequest request,
			HttpServletResponse response) throws Exception;

	/**
	 * Must be implemented by subclasses to set the title for the requested
	 * page. The value returned should be a key String from the
	 * ApplicationResources.properties file.
	 * 
	 * @return the title key for this page.
	 */
	protected abstract String getPageTitleKey();

	/**
	 * Must be implemented by subclasses to set the subtitle for the requested
	 * page. The value returned should be a key String from the
	 * ApplicationResources.properties file.
	 * 
	 * @return the subtitle key this page.
	 */
	protected abstract String getPageSubtitleKey();

	/**
	 * This getPageTitleKey method accepts a request and form parameter so that
	 * a subclass can override the method and conditionally return different
	 * titles.
	 * 
	 * @param request
	 *            the request
	 * @param form
	 *            the form associated with this request.
	 * @return the title key for this page.
	 */
	protected String getPageTitleKey(HttpServletRequest request, ActionForm form) {
		return getPageTitleKey();
	}

	protected String getPageTitleKeyParameter(HttpServletRequest request, ActionForm form) {
		return null;
	}

	/**
	 * This getSubtitleKey method accepts a request and form parameter so that a
	 * subclass can override the method and conditionally return different
	 * subtitles.
	 * 
	 * @param request
	 *            the request
	 * @param form
	 *            the form associated with this request.
	 * @return the subtitle key this page.
	 */
	protected String getPageSubtitleKey(HttpServletRequest request, ActionForm form) {
		return getPageSubtitleKey();
	}

	protected String getPageSubtitleKeyParameter(HttpServletRequest request, ActionForm form) {
		return null;
	}

	/**
	 * Utility method to simplify the lookup of MessageResource Strings in the
	 * ApplicationResources.properties file for this application.
	 * 
	 * @param messageKey
	 *            the message key to look up
	 */
	protected String getMessageForKey(String messageKey) throws Exception {
		String message = StringUtil.getContextualMessageForKey(messageKey);
		return message == null ? getActualMessage( messageKey ) : message;
	}

	/**
	 * Template method to allow subclasses to handle special cases.  The default is to return the message
	 * @param message The message
	 * @return The message
	 */
	protected String getActualMessage(String message) {
		return message;
	}

	protected String getMessageForKey(HttpServletRequest request, String messageKey, String arg0) throws Exception {
		if (null == messageKey)
			return null;
		java.util.Locale locale = (java.util.Locale) request.getSession().getAttribute("org.apache.struts.action.LOCALE");
		// Return the message for the user's locale.
		return ResourceLocator.getInstance().getMessageResources().getMessage(locale, messageKey, arg0);
	}

	protected void setFormAttributes(ActionForm form, HttpServletRequest request) throws Exception {
		try {
			if (null != form) {
				DynaActionForm theForm = (DynaActionForm) form;
				theForm.getDynaClass().getName();
				String name = theForm.getDynaClass().getName();
				// use IActionConstants!
				request.setAttribute(FORM_NAME, name);
				request.setAttribute("formType", theForm.getClass().toString());
				String actionName = name.substring(1, name.length() - 4);
				actionName = name.substring(0, 1).toUpperCase() + actionName;
				request.setAttribute(ACTION_KEY, actionName);

				LogEvent.logInfo("BaseAction", "setFormAttributes()", actionName);
			}
		} catch (ClassCastException e) {
			LogEvent.logError("BaseAction", "setFormAttributes()", e.toString());
			throw new ClassCastException("Error Casting form into DynaForm");
		}
	}

	protected ActionForward getForward(ActionForward forward, String id, String startingRecNo) {
		ActionRedirect redirect = new ActionRedirect(forward);

		if (id != null)
			redirect.addParameter(ID, id);
		if (startingRecNo != null)
			redirect.addParameter("startingRecNo", startingRecNo);
		return redirect;
	}

	protected ActionForward getForwardWithParameters(ActionForward forward, Map<String, String> params) {
		ActionRedirect redirect = new ActionRedirect(forward);

		for (String param : params.keySet()) {
			redirect.addParameter(param, params.get(param));
		}
		return redirect;
	}

	protected ActionForward getForward(ActionForward forward, String id, String startingRecNo, String direction) {
		ActionRedirect redirect = new ActionRedirect(forward);
		LogEvent.logInfo("BaseAction", "getForward()", "This is forward " + forward.getRedirect() + " " + forward.getPath());

		if (id != null)
			redirect.addParameter(ID, id);
		if (startingRecNo != null)
			redirect.addParameter("startingRecNo", startingRecNo);
		if (direction != null)
			redirect.addParameter("direction", direction);
		LogEvent.logInfo("BaseAction", "getForward()", "This is redirect " + redirect.getPath());

		return redirect;
	}

	// N.B. Unless validating accession numbers is part of the concept of
	// actions this should be moved to
	// a utility
	protected ActionMessages validateAccessionNumber(HttpServletRequest request, ActionMessages errors, BaseActionForm dynaForm)
			throws Exception {

		String formName = dynaForm.getDynaClass().getName();

		AccessionNumberValidationProvider accessionNumberValidator = new AccessionNumberValidationProvider();

		String accessionNumber;

		if (!StringUtil.isNullorNill(request.getParameter(ACCESSION_NUMBER))) {
			accessionNumber = request.getParameter(ACCESSION_NUMBER);
		} else {
			accessionNumber = (String) dynaForm.get(ACCESSION_NUMBER);
		}
		String result = accessionNumberValidator.validate(accessionNumber, formName);

		String messageKey = "sample.accessionNumber";
		if (result.equals(INVALID)) {
			ActionError error = new ActionError("errors.invalid", getMessageForKey(messageKey), null);
			errors.add(ActionMessages.GLOBAL_MESSAGE, error);
		}
		if (result.equals(INVALIDSTATUS)) {
			ActionError error = new ActionError("error.invalid.sample.status", getMessageForKey(messageKey), null);
			errors.add(ActionMessages.GLOBAL_MESSAGE, error);
		}
		return errors;
	}

	// N.B. Unless sorting tests is part of the concept of actions this should
	// be moved to a utility
	protected List<Analysis> sortTests(List<Analysis> analyses) {

		List<Analysis> rootLevelNodes = new ArrayList<Analysis>();
		for (int i = 0; i < analyses.size(); i++) {
			Analysis analysis = analyses.get(i);
			String analysisId = analysis.getId();

			List<Analysis> children = new ArrayList<Analysis>();
			for (Analysis analyse : analyses) {
				if (analyse.getParentAnalysis() != null && analyse.getParentAnalysis().getId().equals(analysisId)) {
					children.add(analyse);
				}
			}
			analysis.setChildren(children);

			if (analysis.getParentAnalysis() == null) {
				rootLevelNodes.add(analysis);
			}
		}

		// sort rootLevelNodes
		Collections.sort(rootLevelNodes, BaseTestComparator.SORT_ORDER_COMPARATOR);

		analyses = new ArrayList<Analysis>();
		for (Analysis rootLevelNode : rootLevelNodes) {
			analyses.add(rootLevelNode);
			recursiveSort(rootLevelNode, analyses);
		}

		return analyses;
	}

	private void recursiveSort(Analysis element, List<Analysis> analyses) {
		List<Analysis> children = element.getChildren();
		// sort children
		if (children != null && children.size() > 0) {
			Collections.sort(children, BaseTestComparator.SORT_ORDER_COMPARATOR);
		}
		for (Analysis childElement : children) {
			analyses.add(childElement);
			recursiveSort(childElement, analyses);
		}
	}

	protected String getSysUserId(HttpServletRequest request) {
		UserSessionData usd = (UserSessionData) request.getSession().getAttribute(USER_SESSION_DATA);
		return String.valueOf(usd.getSystemUserId());
	}

	protected void setSuccessFlag(HttpServletRequest request, String forwardFlag) {
		request.setAttribute(FWD_SUCCESS, FWD_SUCCESS.equals(forwardFlag));
	}

	protected void setSuccessFlag(HttpServletRequest request) {
		request.setAttribute(FWD_SUCCESS, Boolean.TRUE);
	}
}