/*
    * 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.coa.document.validation.impl;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.kfs.coa.businessobject.Account;
  import org.kuali.kfs.coa.service.AccountService;
  import org.kuali.kfs.sys.KFSKeyConstants;
  import org.kuali.kfs.sys.context.SpringContext;
  import org.kuali.rice.core.api.config.property.ConfigurationService;
  import org.kuali.rice.kns.document.MaintenanceDocument;
  import org.kuali.rice.kns.rules.PromptBeforeValidationBase;
  import org.kuali.rice.krad.document.Document;
  import org.kuali.rice.krad.util.ObjectUtils;
  
  /**
   * General PreRules checks for all Maintenance docs that needs to occur while still in the Struts processing.
   */
  public class MaintenancePreRulesBase extends PromptBeforeValidationBase {
  
      protected ConfigurationService configService;
      protected AccountService accountService;
  
      /**
       * Constructs a MaintenancePreRulesBase class and injects some services through setters
       * 
       * @TODO: should be fixed in the future to use Spring to inject these services
       */
      public MaintenancePreRulesBase() {
          // Pseudo-inject some services.
          //
          // This approach is being used to make it simpler to convert the Rule classes
          // to spring-managed with these services injected by Spring at some later date.
          // When this happens, just remove these calls to the setters with
          // SpringContext, and configure the bean defs for spring.
          setAccountService(SpringContext.getBean(AccountService.class));
          setConfigService(SpringContext.getBean(ConfigurationService.class));
      }
  
      public void setAccountService(AccountService accountService) {
          this.accountService = accountService;
      }
  
      public void setConfigService(ConfigurationService configService) {
          this.configService = configService;
      }
  
      /**
       * This is called from the rules service to execute our rules A hook is provided here for sub-classes to override the
       * {@link MaintenancePreRulesBase#doCustomPreRules(MaintenanceDocument)}
       * 
       * @see org.kuali.rice.kns.rules.PromptBeforeValidationBase#doRules(org.kuali.rice.krad.document.Document)
       */
      @Override
      public boolean doPrompts(Document document) {
          MaintenanceDocument maintenanceDocument = (MaintenanceDocument) document;
          return doCustomPreRules(maintenanceDocument);
      }
  
      /**
       * This is a hook for sub-classes to implement their own pre-rules. Override to get hooked into main class
       * 
       * @param maintenanceDocument
       * @return true if rules pass
       */
      protected boolean doCustomPreRules(MaintenanceDocument maintenanceDocument) {
          return true;
      }
  
      /**
       * This method checks for continuation accounts, returns the continuation account if it is found, null otherwise
       * 
       * @param accName
       * @param chart
       * @param accountNumber
       * @param accountName
       * @param allowExpiredAccount
       * @return the continuation account if it is found, null otherwise
       */
      protected Account checkForContinuationAccount(String accName, String chart, String accountNumber, String accountName, boolean allowExpiredAccount) {
          Account result = checkForContinuationAccount(accName, chart, accountNumber, accountName);
          if (!allowExpiredAccount) {
              if (result.isExpired()) {
                 return null;
             }
         }
         return result;
     }
 
     /**
      * This method checks for continuation accounts and presents the user with a question regarding their use on this account.
      * 
      * @param accName
      * @param chart
      * @param accountNumber
      * @param accountName
      * @return
      */
     protected Account checkForContinuationAccount(String accName, String chart, String accountNumber, String accountName) {
         if (LOG.isDebugEnabled()) {
             LOG.debug("entering checkForContinuationAccounts(" + accountNumber + ")");
         }
         if (StringUtils.isBlank(accountNumber) || StringUtils.isBlank(chart))
             return null;
 
         Account account = accountService.getByPrimaryId(chart, accountNumber);
 
         if (ObjectUtils.isNotNull(account) && !account.isExpired()) { // no need for a continuation account
             return null;
         }
 
         boolean useContinuationAccount = true;
 
         while (ObjectUtils.isNotNull(account) && account.isExpired() && useContinuationAccount) {
             if (LOG.isDebugEnabled()) {
                 LOG.debug("Expired account: " + accountNumber);    
             }
             String continuationAccountNumber = account.getContinuationAccountNumber();
 
             useContinuationAccount = askOrAnalyzeYesNoQuestion("ContinuationAccount" + accName + accountNumber, buildContinuationConfirmationQuestion(accName, accountNumber, continuationAccountNumber));
             if (useContinuationAccount) {
                 String continuationChart = account.getContinuationFinChrtOfAcctCd();
                 account = accountService.getByPrimaryId(continuationChart, continuationAccountNumber);
 
                 if (ObjectUtils.isNotNull(account)) {
                     accountNumber = account.getAccountNumber();
                 }
 
                 if (LOG.isDebugEnabled()) {
                     LOG.debug("Selected continuation account: " + account);
                 }
             }
         }
         return account;
 
     }
 
 
     /**
      * This method builds up the continuation account confirmation question that will be presented to the user
      * 
      * @param accName
      * @param expiredAccount
      * @param continuationAccount
      * @return the question to the user about the continuation account
      */
     protected String buildContinuationConfirmationQuestion(String accName, String expiredAccount, String continuationAccount) {
         String result = configService.getPropertyValueAsString(KFSKeyConstants.QUESTION_CONTINUATION_ACCOUNT_SELECTION);
         result = StringUtils.replace(result, "{0}", accName);
         result = StringUtils.replace(result, "{1}", expiredAccount);
         result = StringUtils.replace(result, "{2}", continuationAccount);
         return result;
     }
 
     public AccountService getAccountService() {
         return accountService;
     }
 
     public ConfigurationService getConfigService() {
         return configService;
     }
 
 }