/*
    * The Kuali Financial System, a comprehensive financial management system for higher education.
    * 
    * Copyright 2005-2014 The Kuali Foundation
    * 
    * This program is free software: you can redistribute it and/or modify
    * it under the terms of the GNU Affero General Public License as
    * published by the Free Software Foundation, either version 3 of the
    * License, or (at your option) any later version.
   * 
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU Affero General Public License for more details.
   * 
   * You should have received a copy of the GNU Affero General Public License
   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
   */
  package org.kuali.kfs.module.tem.document.authorization;
  
  import java.util.Set;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.kfs.module.tem.TemConstants;
  import org.kuali.kfs.module.tem.TemConstants.TravelAuthorizationParameters;
  import org.kuali.kfs.module.tem.TemConstants.TravelEditMode;
  import org.kuali.kfs.module.tem.TemWorkflowConstants;
  import org.kuali.kfs.module.tem.document.TravelAuthorizationDocument;
  import org.kuali.kfs.module.tem.document.TravelDocument;
  import org.kuali.kfs.module.tem.document.service.TravelDocumentService;
  import org.kuali.kfs.module.tem.service.TemProfileService;
  import org.kuali.kfs.module.tem.service.TemRoleService;
  import org.kuali.kfs.sys.KFSConstants;
  import org.kuali.kfs.sys.KfsAuthorizationConstants;
  import org.kuali.kfs.sys.context.SpringContext;
  import org.kuali.kfs.sys.document.authorization.FinancialSystemTransactionalDocumentPresentationControllerBase;
  import org.kuali.rice.core.api.config.property.ConfigurationService;
  import org.kuali.rice.coreservice.framework.parameter.ParameterService;
  import org.kuali.rice.kew.api.WorkflowDocument;
  import org.kuali.rice.kew.api.action.ActionRequest;
  import org.kuali.rice.kim.api.identity.Person;
  import org.kuali.rice.kns.document.authorization.DocumentAuthorizer;
  import org.kuali.rice.kns.service.DocumentHelperService;
  import org.kuali.rice.krad.document.Document;
  import org.kuali.rice.krad.util.GlobalVariables;
  
  /**
   * Travel Document Presentation Controller
   *
   */
  public class TravelDocumentPresentationController extends FinancialSystemTransactionalDocumentPresentationControllerBase{
      protected volatile TravelDocumentService travelDocumentService;
  
      /**
       * @see org.kuali.kfs.sys.document.authorization.FinancialSystemTransactionalDocumentPresentationControllerBase#getEditModes(org.kuali.rice.kns.document.Document)
       */
      @Override
      public Set<String> getEditModes(Document document) {
          Set<String> editModes = super.getEditModes(document);
          ParameterService paramService = SpringContext.getBean(ParameterService.class);
  
          if (paramService.getParameterValueAsBoolean(TravelAuthorizationDocument.class, TravelAuthorizationParameters.DISPLAY_EMERGENCY_CONTACT_IND)) {
              editModes.add(TemConstants.DISPLAY_EMERGENCY_CONTACT_TAB);
          }
  
          editModes.add(KfsAuthorizationConstants.TransactionalEditMode.IMMEDIATE_DISBURSEMENT_ENTRY);
          editModes.add(TemConstants.EditModes.CHECK_AMOUNT_ENTRY);
  
          if (document.getDocumentHeader().getWorkflowDocument().getNodeNames().contains(KFSConstants.RouteLevelNames.PAYMENT_METHOD)) {
              editModes.add(KfsAuthorizationConstants.TransactionalEditMode.WIRE_ENTRY);
              editModes.add(KfsAuthorizationConstants.TransactionalEditMode.FRN_ENTRY);
          }
  
          if (document.getDocumentHeader().getWorkflowDocument().isInitiated() || document.getDocumentHeader().getWorkflowDocument().isSaved() || isActionRequestedOfCurrentUser(document)) {
              editModes.add(TemConstants.EditModes.CONVERSION_RATE_ENTRY);
          }
          return editModes;
      }
  
      /**
       * Determines if there's an action request for the current user
       * @param document the document to check action requests on
       * @return true if there are action requests for the current user, false otherwise
       */
      protected boolean isActionRequestedOfCurrentUser(Document document) {
          final Person currentUser = GlobalVariables.getUserSession().getPerson();
          for (ActionRequest request : document.getDocumentHeader().getWorkflowDocument().getRootActionRequests()) {
              if (request.getActionTaken() == null) {
                  if (StringUtils.equals(currentUser.getPrincipalId(), request.getPrincipalId())) {
                      return true;
                  }
                  if (request.getChildRequests() != null && !request.getChildRequests().isEmpty()) {
                      for (ActionRequest childRequest : request.getChildRequests()) {
                          if (StringUtils.equals(currentUser.getPrincipalId(), childRequest.getPrincipalId())) {
                              return true;
                          }
                      }
                  }
              }
         }
         return false;
     }
 
     /**
      * Check user's edit permission in order to grant full entry edit
      *
      * When the document is routed to document manager's approval node, check for permission on document
      * manager to get full edit
      *
      * @param document
      * @param editModes
      */
     protected void addFullEntryEditMode(Document document, Set<String> editModes) {
         WorkflowDocument workflowDocument = document.getDocumentHeader().getWorkflowDocument();
         Person currentUser = GlobalVariables.getUserSession().getPerson();
 
         DocumentAuthorizer authorizer = getDocumentHelperService().getDocumentAuthorizer(document);
         TravelArrangeableAuthorizer travelAuthorizer = (TravelArrangeableAuthorizer)authorizer;
 
         //check edit permission when document is in init or saved
         if ((workflowDocument.isInitiated() || workflowDocument.isSaved())) {
             //check for edit permission on the document
             if (travelAuthorizer.canEditDocument(document, currentUser)){
                 editModes.add(TravelEditMode.FULL_ENTRY);
             }
         } else if(isAtNode(workflowDocument, getDocumentManagerApprovalNode())){ //Document manager will also get full entry edit mode on the approval node
             if (travelAuthorizer.canEditDocument(document, currentUser)){
                 editModes.add(TravelEditMode.FULL_ENTRY);
             }
         }
     }
 
     /**
      * Check if workflow is at the specific node
      *
      * @param workflowDocument
      * @param nodeName
      * @return
      */
     public boolean isAtNode(WorkflowDocument workflowDocument, String nodeName) {
         Set<String> nodeNames = workflowDocument.getNodeNames();
         for (String nodeNamesNode : nodeNames) {
             if (nodeName.equals(nodeNamesNode)) {
                 return true;
             }
         }
         return false;
     }
 
     /**
      * Get the Document Manager approval node
      *
      * Default to Travel Manager's - AP_TRAVEL
      *
      * @return
      */
     public String getDocumentManagerApprovalNode(){
         return TemWorkflowConstants.RouteNodeNames.AP_TRAVEL;
     }
 
     /**
      * Check current user is the initiator
      *
      * @param workflowDocument
      * @return
      */
     public boolean isInitiator(WorkflowDocument workflowDocument){
         String docInitiator = workflowDocument.getInitiatorPrincipalId();
         Person currentUser = GlobalVariables.getUserSession().getPerson();
         return docInitiator.equals(currentUser.getPrincipalId());
     }
 
     /**
      * Determines if the given travel doc is the "root" travel document
      * @param travelDoc the travel document to verify
      * @return true if the travel document is the root document, false otherwise
      */
     protected boolean isRootTravelDocument(TravelDocument travelDoc) {
         if (StringUtils.isBlank(travelDoc.getTravelDocumentIdentifier())) {
             // no trip id?  then we must be the root
             return true;
         }
         final TravelDocument baseTravelDocument = getTravelDocumentService().getParentTravelDocument(travelDoc.getTravelDocumentIdentifier());
         return baseTravelDocument == null || StringUtils.equals(baseTravelDocument.getDocumentNumber(), travelDoc.getDocumentNumber());
     }
 
     public ParameterService getParamService() {
         return SpringContext.getBean(ParameterService.class);
     }
 
     protected TemRoleService getTemRoleService() {
         return SpringContext.getBean(TemRoleService.class);
     }
 
     protected TemProfileService getTemProfileService() {
         return SpringContext.getBean(TemProfileService.class);
     }
 
     protected DocumentHelperService getDocumentHelperService() {
         return SpringContext.getBean(DocumentHelperService.class);
     }
 
     protected ConfigurationService getConfigurationService() {
         return SpringContext.getBean(ConfigurationService.class);
     }
 
     protected TravelDocumentService getTravelDocumentService() {
         if (travelDocumentService == null) {
             travelDocumentService = SpringContext.getBean(TravelDocumentService.class);
         }
         return travelDocumentService;
     }
 }