/**

  * Copyright 2005-2011 The Kuali Foundation

  *

  * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php

  *

  * 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 org.kuali.rice.krad.web.form;

 import org.apache.commons.lang.StringUtils;

 import org.codehaus.jackson.map.ObjectMapper;

 import org.kuali.rice.krad.service.KRADServiceLocatorWeb;

 import org.kuali.rice.krad.uif.UifConstants;

 import org.kuali.rice.krad.uif.UifParameters;

 import org.kuali.rice.krad.uif.view.History;

 import org.kuali.rice.krad.uif.view.View;

 import org.kuali.rice.krad.uif.service.ViewService;

 import org.kuali.rice.krad.uif.view.ViewModel;

 import org.kuali.rice.krad.util.KRADUtils;

 import org.springframework.web.multipart.MultipartFile;

 import org.kuali.rice.krad.uif.UifConstants.ViewType;

 import javax.servlet.http.HttpServletRequest;

 import java.io.IOException;

 import java.util.ArrayList;

 import java.util.HashMap;

 import java.util.List;

 import java.util.Map;

 import java.util.Properties;

 import java.util.Set;

 import java.util.UUID;

 /**

  * Base form class for views within the KRAD User Interface Framework

  *

  * <p>

  * Holds properties necessary to determine the <code>View</code> instance that

  * will be used to render the UI

  * </p>

  *

  * @author Kuali Rice Team (rice.collab@kuali.org)

  */

 public class UifFormBase implements ViewModel {

     private static final long serialVersionUID = 8432543267099454434L;

     // current view

     protected String viewId;

     protected String viewName;

     protected ViewType viewTypeName;

     protected String pageId;

     protected String methodToCall;

     protected String formKey;

     protected String jumpToId;

     protected String jumpToName;

     protected String focusId;

     protected String formPostUrl;

     protected boolean defaultsApplied;

     protected View view;

     protected View previousView;

     protected Map<String, String> viewRequestParameters;

     protected List<String> readOnlyFieldsList;

     protected Map<String, Object> newCollectionLines;

     protected Map<String, String> actionParameters;

     protected Map<String, Object> clientStateForSyncing;

     protected Map<String, Set<String>> selectedCollectionLines;

     protected MultipartFile attachmentFile;

     // navigation

     protected String returnLocation;

     protected String returnFormKey;

     protected History formHistory;

     protected boolean renderFullView;

     protected boolean validateDirty;

     public UifFormBase() {

         formKey = generateFormKey();

         renderFullView = true;

         defaultsApplied = false;

         readOnlyFieldsList = new ArrayList<String>();

         viewRequestParameters = new HashMap<String, String>();

         newCollectionLines = new HashMap<String, Object>();

         actionParameters = new HashMap<String, String>();

         clientStateForSyncing = new HashMap<String, Object>();

         selectedCollectionLines = new HashMap<String, Set<String>>();

     }

     /**

      * Creates the unique id used to store this "conversation" in the session.

      * The default method generates a java UUID.

      *

      * @return

      */

     protected String generateFormKey() {

         return UUID.randomUUID().toString();

     }

     /**

      * Called after Spring binds the request to the form and before the

      * controller method is invoked.

      *

      * @param request - request object containing the query parameters

      */

     public void postBind(HttpServletRequest request) {

         // default form post URL to request URL

         formPostUrl = request.getRequestURL().toString();

         // get any sent client view state and parse into map

         if (request.getParameterMap().containsKey(UifParameters.CLIENT_VIEW_STATE)) {

             String clientStateJSON = request.getParameter(UifParameters.CLIENT_VIEW_STATE);

             if (StringUtils.isNotBlank(clientStateJSON)) {

                 // change single quotes to double quotes (necessary because the reverse was done for sending)

                 clientStateJSON = StringUtils.replace(clientStateJSON, "'", "\"");

                 ObjectMapper mapper = new ObjectMapper();

                 try {

                     clientStateForSyncing = mapper.readValue(clientStateJSON, Map.class);

                 } catch (IOException e) {

                     throw new RuntimeException("Unable to decode client side state JSON", e);

                 }

             }

         }

         // populate read only fields list

         if (request.getParameter(UifParameters.READ_ONLY_FIELDS) != null) {

             String readOnlyFields = request.getParameter(UifParameters.READ_ONLY_FIELDS);

             setReadOnlyFieldsList(KRADUtils.convertStringParameterToList(readOnlyFields));

         }

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#getViewId()

      */

     public String getViewId() {

         return this.viewId;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#setViewId(java.lang.String)

      */

     public void setViewId(String viewId) {

         this.viewId = viewId;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#getViewName()

      */

     public String getViewName() {

         return this.viewName;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#setViewName(java.lang.String)

      */

     public void setViewName(String viewName) {

         this.viewName = viewName;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#getViewTypeName()

      */

     public ViewType getViewTypeName() {

         return this.viewTypeName;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#setViewTypeName(org.kuali.rice.krad.uif.UifConstants.ViewType)

      */

     public void setViewTypeName(ViewType viewTypeName) {

         this.viewTypeName = viewTypeName;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#getPageId()

      */

     public String getPageId() {

         return this.pageId;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#setPageId(java.lang.String)

      */

     public void setPageId(String pageId) {

         this.pageId = pageId;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#getFormPostUrl()

      */

     public String getFormPostUrl() {

         return this.formPostUrl;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#setFormPostUrl(java.lang.String)

      */

     public void setFormPostUrl(String formPostUrl) {

         this.formPostUrl = formPostUrl;

     }

     public String getReturnLocation() {

         return this.returnLocation;

     }

     public void setReturnLocation(String returnLocation) {

         this.returnLocation = returnLocation;

     }

     public String getReturnFormKey() {

         return this.returnFormKey;

     }

     public void setReturnFormKey(String returnFormKey) {

         this.returnFormKey = returnFormKey;

     }

     /**

      * Identifies the controller method that should be invoked to fulfill a

      * request. The value will be matched up against the 'params' setting on the

      * <code>RequestMapping</code> annotation for the controller method

      *

      * @return String method to call

      */

     public String getMethodToCall() {

         return this.methodToCall;

     }

     /**

      * Setter for the method to call

      *

      * @param methodToCall

      */

     public void setMethodToCall(String methodToCall) {

         this.methodToCall = methodToCall;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#getViewRequestParameters()

      */

     public Map<String, String> getViewRequestParameters() {

         return this.viewRequestParameters;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#setViewRequestParameters(java.util.Map<java.lang.String,java.lang.String>)

      */

     public void setViewRequestParameters(Map<String, String> viewRequestParameters) {

         this.viewRequestParameters = viewRequestParameters;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#getReadOnlyFieldsList()

      */

     public List<String> getReadOnlyFieldsList() {

         return readOnlyFieldsList;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#setReadOnlyFieldsList(java.util.List<java.lang.String>)

      */

     public void setReadOnlyFieldsList(List<String> readOnlyFieldsList) {

         this.readOnlyFieldsList = readOnlyFieldsList;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#getNewCollectionLines()

      */

     public Map<String, Object> getNewCollectionLines() {

         return this.newCollectionLines;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#setNewCollectionLines(java.util.Map<java.lang.String,java.lang.Object>)

      */

     public void setNewCollectionLines(Map<String, Object> newCollectionLines) {

         this.newCollectionLines = newCollectionLines;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#getActionParameters()

      */

     public Map<String, String> getActionParameters() {

         return this.actionParameters;

     }

     /**

      * Returns the action parameters map as a <code>Properties</code> instance

      *

      * @return Properties action parameters

      */

     public Properties getActionParametersAsProperties() {

         Properties actionProperties = new Properties();

         if (actionParameters != null) {

             for (Map.Entry<String, String> actionParameter : actionParameters.entrySet()) {

                 actionProperties.put(actionParameter.getKey(), actionParameter.getValue());

             }

         }

         return actionProperties;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#setActionParameters(java.util.Map<java.lang.String,java.lang.String>)

      */

     public void setActionParameters(Map<String, String> actionParameters) {

         this.actionParameters = actionParameters;

     }

     /**

      * Retrieves the value for the given action parameter, or empty string if

      * not found

      *

      * @param actionParameterName - name of the action parameter to retrieve value for

      * @return String parameter value or empty string

      */

     public String getActionParamaterValue(String actionParameterName) {

         if ((actionParameters != null) && actionParameters.containsKey(actionParameterName)) {

             return actionParameters.get(actionParameterName);

         }

         return "";

     }

     /**

      * Returns the action event that was sent in the action parameters (if any)

      *

      * <p>

      * The action event is a special action parameter that can be sent to indicate a type of action being taken. This

      * can be looked at by the view or components to render differently

      * </p>

      *

      * TODO: make sure action parameters are getting reinitialized on each request

      *

      * @return String action event name or blank if action event was not sent

      */

     public String getActionEvent() {

         if ((actionParameters != null) && actionParameters.containsKey(UifConstants.UrlParams.ACTION_EVENT)) {

             return actionParameters.get(UifConstants.UrlParams.ACTION_EVENT);

         }

         return "";

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#getClientStateForSyncing()

      */

     public Map<String, Object> getClientStateForSyncing() {

         return clientStateForSyncing;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#getSelectedCollectionLines()

      */

     public Map<String, Set<String>> getSelectedCollectionLines() {

         return selectedCollectionLines;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#setSelectedCollectionLines(java.util.Map<java.lang.String,java.util.Set<java.lang.String>>)

      */

     public void setSelectedCollectionLines(Map<String, Set<String>> selectedCollectionLines) {

         this.selectedCollectionLines = selectedCollectionLines;

     }

     /**

      * Key string that identifies the form instance in session storage

      *

      * <p>

      * When the view is posted, the previous form instance is retrieved and then

      * populated from the request parameters. This key string is retrieve the

      * session form from the session service

      * </p>

      *

      * @return String form session key

      */

     public String getFormKey() {

         return this.formKey;

     }

     /**

      * Setter for the form's session key

      *

      * @param formKey

      */

     public void setFormKey(String formKey) {

         this.formKey = formKey;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#isDefaultsApplied()

      */

     public boolean isDefaultsApplied() {

         return this.defaultsApplied;

     }

     /**

      * @see org.kuali.rice.krad.uif.view.ViewModel#setDefaultsApplied(boolean)

      */

     public void setDefaultsApplied(boolean defaultsApplied) {

         this.defaultsApplied = defaultsApplied;

     }

     /**

      * Holder for files that are attached through the view

      *

      * @return MultipartFile representing the attachment

      */

     public MultipartFile getAttachmentFile() {

         return this.attachmentFile;

     }

     /**

      * Setter for the form's attachment file

      *

      * @param attachmentFile

      */

     public void setAttachmentFile(MultipartFile attachmentFile) {

         this.attachmentFile = attachmentFile;

     }

     /**

      * @return the renderFullView

      */

     public boolean isRenderFullView() {

         return this.renderFullView;

     }

     /**

      * @param renderFullView

      */

     public void setRenderFullView(boolean renderFullView) {

         this.renderFullView = renderFullView;

     }

     /**

      * View instance associated with the form. Used to render the user interface

      *

      * @return View

      */

     public View getView() {

         return this.view;

     }

     /**

      * Setter for the view instance

      *

      * @param view

      */

     public void setView(View view) {

         this.view = view;

     }

     /**

      * View instance for the page that made a request. Since a new view instance

      * gets initialized for each request before the controller logic is invoked,

      * any state about the previous view is lost. This could be needed to read

      * metadata from the view for such things as collection processing. When

      * this is necessary the previous view instance can be retrieved

      *

      * @return View instance

      */

     public View getPreviousView() {

         return this.previousView;

     }

     /**

      * Setter for the previous view instance

      *

      * @param previousView

      */

     public void setPreviousView(View previousView) {

         this.previousView = previousView;

     }

     /**

      * Instance of the <code>ViewService</code> that can be used to retrieve

      * <code>View</code> instances

      *

      * @return ViewService implementation

      */

     protected ViewService getViewService() {

         return KRADServiceLocatorWeb.getViewService();

     }

     /**

      * The jumpToId for this form, the element with this id will be jumped to automatically

      * when the form is loaded in the view.

      * Using "TOP" or "BOTTOM" will jump to the top or the bottom of the resulting page.

      * jumpToId always takes precedence over jumpToName, if set.

      *

      * @return the jumpToId

      */

     public String getJumpToId() {

         return this.jumpToId;

     }

     /**

      * @param jumpToId the jumpToId to set

      */

     public void setJumpToId(String jumpToId) {

         this.jumpToId = jumpToId;

     }

     /**

      * The jumpToName for this form, the element with this name will be jumped to automatically

      * when the form is loaded in the view.

      * WARNING: jumpToId always takes precedence over jumpToName, if set.

      *

      * @return the jumpToName

      */

     public String getJumpToName() {

         return this.jumpToName;

     }

     /**

      * @param jumpToName the jumpToName to set

      */

     public void setJumpToName(String jumpToName) {

         this.jumpToName = jumpToName;

     }

     /**

      * Field to place focus on when the page loads

      * An empty focusId will result in focusing on the first visible input element by default.

      *

      * @return the focusId

      */

     public String getFocusId() {

         return this.focusId;

     }

     /**

      * @param focusId the focusId to set

      */

     public void setFocusId(String focusId) {

         this.focusId = focusId;

     }

     /**

      * History parameter representing the History of views that have come before the

      * viewing of the current view

      *

      * <p>

      * Used for breadcrumb widget generation on the view and also for navigating back

      * to previous or hub locations

      * </p>

      *

      * @return History instance giving current history

      */

     public History getFormHistory() {

         return formHistory;

     }

     /**

      * Setter for the current History object

      *

      * @param history the history to set

      */

     public void setFormHistory(History history) {

         this.formHistory = history;

     }

     /**

      * Indicates whether the form should be validated for dirtyness

      *

      * <p>

      * For FormView, it's necessary to validate when the user tries to navigate out of the form. If set, all the

      * InputFields will be validated on refresh, navigate, cancel or close Action or on form

      * unload and if dirty, displays a message and user can decide whether to continue with

      * the action or stay on the form

      * </p>

      *

      * @return boolean true if dirty validation should be enabled

      */

     public boolean isValidateDirty() {

         return this.validateDirty;

     }

     /**

      * Setter for dirty validation indicator

      *

      * @param validateDirty

      */

     public void setValidateDirty(boolean validateDirty) {

         this.validateDirty = validateDirty;

     }

 }