/*

  * Copyright 2005-2008 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.kns.service.impl;

 import java.util.ArrayList;

 import java.util.List;

 import org.apache.commons.lang.StringUtils;

 import org.apache.log4j.Logger;

 import org.kuali.rice.kns.bo.AdHocRoutePerson;

 import org.kuali.rice.kns.bo.AdHocRouteWorkgroup;

 import org.kuali.rice.kns.document.Document;

 import org.kuali.rice.kns.document.MaintenanceDocument;

 import org.kuali.rice.kns.document.TransactionalDocument;

 import org.kuali.rice.kns.exception.InfrastructureException;

 import org.kuali.rice.kns.rule.BusinessRule;

 import org.kuali.rice.kns.rule.event.AddAdHocRoutePersonEvent;

 import org.kuali.rice.kns.rule.event.AddAdHocRouteWorkgroupEvent;

 import org.kuali.rice.kns.rule.event.KualiDocumentEvent;

 import org.kuali.rice.kns.service.DataDictionaryService;

 import org.kuali.rice.kns.service.DictionaryValidationService;

 import org.kuali.rice.kns.service.KualiRuleService;

 import org.kuali.rice.kns.service.MaintenanceDocumentDictionaryService;

 import org.kuali.rice.kns.service.TransactionalDocumentDictionaryService;

 import org.kuali.rice.kns.util.GlobalVariables;

 import org.kuali.rice.kns.util.KNSConstants;

 import org.kuali.rice.kns.util.MessageMap;

 /**

  * This class represents a rule evaluator for Kuali. This class is to be used for evaluating business rule checks. The class defines

  * one method right now - applyRules() which takes in a Document and a DocumentEvent and does the proper business rule checks based

  * on the context of the event and the document type.

  */

 public class KualiRuleServiceImpl implements KualiRuleService {

     private static final Logger LOG = Logger.getLogger(KualiRuleServiceImpl.class);

     private TransactionalDocumentDictionaryService transactionalDocumentDictionaryService;

     private MaintenanceDocumentDictionaryService maintenanceDocumentDictionaryService;

     private DictionaryValidationService dictionaryValidationService;

     private DataDictionaryService dataDictionaryService;

     /**

      * @see org.kuali.rice.kns.service.KualiRuleService#applyRules(org.kuali.rice.kns.rule.event.KualiDocumentEvent)

      */

     public boolean applyRules(KualiDocumentEvent event) {

         if (event == null) {

             throw new IllegalArgumentException("invalid (null) event");

         }

         event.validate();

         if ( LOG.isDebugEnabled() ) {

                 LOG.debug("calling applyRules for event " + event);

         }

         BusinessRule rule = getBusinessRulesInstance(event.getDocument(), event.getRuleInterfaceClass());

         boolean success = true;

         if (rule != null) {

                 if ( LOG.isDebugEnabled() ) {        

                         LOG.debug("processing " + event.getName() + " with rule " + rule.getClass().getName());

                 }

             increaseErrorPath(event.getErrorPathPrefix());

             // get any child events and apply rules

             List<KualiDocumentEvent> events = event.generateEvents();

             for (KualiDocumentEvent generatedEvent : events) {

                 success &= applyRules(generatedEvent);

             }

             // now call the event rule method

             success &= event.invokeRuleMethod(rule);

             decreaseErrorPath(event.getErrorPathPrefix());

             // report failures

             if (!success) {

                     if ( LOG.isDebugEnabled() ) { // NO, this is not a type - only log if in debug mode - this is not an error in production

                             LOG.error(event.getName() + " businessRule " + rule.getClass().getName() + " failed");

                     }

             }

             else {

                     if ( LOG.isDebugEnabled() ) {

                             LOG.debug("processed " + event.getName() + " for rule " + rule.getClass().getName());

                     }

             }

         }

         return success;

     }

     /**

      * Builds a list containing AddAdHocRoutePersonEvents since the validation done for an AdHocRouteRecipient is the same for all

      * events.

      * 

      * @see org.kuali.rice.kns.service.KualiRuleService#generateAdHocRoutePersonEvents(org.kuali.rice.kns.document.Document)

      */

     public List<AddAdHocRoutePersonEvent> generateAdHocRoutePersonEvents(Document document) {

         List<AdHocRoutePerson> adHocRoutePersons = document.getAdHocRoutePersons();

         List<AddAdHocRoutePersonEvent> events = new ArrayList<AddAdHocRoutePersonEvent>();

         for (int i = 0; i < adHocRoutePersons.size(); i++) {

             events.add(new AddAdHocRoutePersonEvent(KNSConstants.EXISTING_AD_HOC_ROUTE_PERSON_PROPERTY_NAME + "[" + i + "]", document, adHocRoutePersons.get(i)));

         }

         return events;

     }

     /**

      * Builds a list containing AddAdHocRoutePersonEvents since the validation done for an AdHocRouteRecipient is the same for all

      * events.

      * 

      * @see org.kuali.rice.kns.service.KualiRuleService#generateAdHocRouteWorkgroupEvents(org.kuali.rice.kns.document.Document)

      */

     public List<AddAdHocRouteWorkgroupEvent> generateAdHocRouteWorkgroupEvents(Document document) {

         List<AdHocRouteWorkgroup> adHocRouteWorkgroups = document.getAdHocRouteWorkgroups();

         List<AddAdHocRouteWorkgroupEvent> events = new ArrayList<AddAdHocRouteWorkgroupEvent>();

         for (int i = 0; i < adHocRouteWorkgroups.size(); i++) {

             events.add(new AddAdHocRouteWorkgroupEvent(KNSConstants.EXISTING_AD_HOC_ROUTE_WORKGROUP_PROPERTY_NAME + "[" + i + "]", document, adHocRouteWorkgroups.get(i)));

         }

         return events;

     }

     /**

      * @param document

      * @param ruleInterface

      * @return instance of the businessRulesClass for the given document's type, if that businessRulesClass implements the given

      *         ruleInterface

      */

     public BusinessRule getBusinessRulesInstance(Document document, Class<? extends BusinessRule> ruleInterface) {

         // get the businessRulesClass

         Class<? extends BusinessRule> businessRulesClass = null;

         if (document instanceof TransactionalDocument) {

             TransactionalDocument transactionalDocument = (TransactionalDocument) document;

             businessRulesClass = transactionalDocumentDictionaryService.getBusinessRulesClass(transactionalDocument);

         }

         else if (document instanceof MaintenanceDocument) {

             MaintenanceDocument maintenanceDocument = (MaintenanceDocument) document;

             businessRulesClass = maintenanceDocumentDictionaryService.getBusinessRulesClass(maintenanceDocument);

         }

         else {

             LOG.error("unable to get businessRulesClass for unknown document type '" + document.getClass().getName() + "'");

         }

         // instantiate and return it if it implements the given ruleInterface

         BusinessRule rule = null;

         if (businessRulesClass != null) {

             try {

                 if (ruleInterface.isAssignableFrom(businessRulesClass)) {

                     rule = businessRulesClass.newInstance();

                 }

             }

             catch (IllegalAccessException e) {

                 throw new InfrastructureException("error processing business rules", e);

             }

             catch (InstantiationException e) {

                 throw new InfrastructureException("error processing business rules", e);

             }

         }

         return rule;

     }

     /**

      * This method increases the registered error path, so that field highlighting can occur on the appropriate object attribute.

      * 

      * @param errorPathPrefix

      */

     private void increaseErrorPath(String errorPathPrefix) {

         MessageMap errorMap = GlobalVariables.getMessageMap();

         if (!StringUtils.isBlank(errorPathPrefix)) {

             errorMap.addToErrorPath(errorPathPrefix);

         }

     }

     /**

      * This method decreases the registered error path, so that field highlighting can occur on the appropriate object attribute.

      * 

      * @param errorPathPrefix

      */

     private void decreaseErrorPath(String errorPathPrefix) {

         MessageMap errorMap = GlobalVariables.getMessageMap();

         if (!StringUtils.isBlank(errorPathPrefix)) {

             errorMap.removeFromErrorPath(errorPathPrefix);

         }

     }

     /* Spring service injection */

     /**

      * @param maintenanceDocumentDictionaryService

      */

     public void setMaintenanceDocumentDictionaryService(MaintenanceDocumentDictionaryService maintenanceDocumentDictionaryService) {

         this.maintenanceDocumentDictionaryService = maintenanceDocumentDictionaryService;

     }

     /**

      * @return MaintenanceDocumentDictionaryService

      */

     public MaintenanceDocumentDictionaryService getMaintenanceDocumentDictionaryService() {

         return maintenanceDocumentDictionaryService;

     }

     /**

      * @param transactionalDocumentDictionaryService

      */

     public void setTransactionalDocumentDictionaryService(TransactionalDocumentDictionaryService transactionalDocumentDictionaryService) {

         this.transactionalDocumentDictionaryService = transactionalDocumentDictionaryService;

     }

     /**

      * @return TransactionalDocumentDictionaryService

      */

     public TransactionalDocumentDictionaryService getTransactionalDocumentDictionaryService() {

         return transactionalDocumentDictionaryService;

     }

     /**

      * @return DictionaryValidationService

      */

     public DictionaryValidationService getDictionaryValidationService() {

         return dictionaryValidationService;

     }

     /**

      * @param dictionaryValidationService

      */

     public void setDictionaryValidationService(DictionaryValidationService dictionaryValidationService) {

         this.dictionaryValidationService = dictionaryValidationService;

     }

     /**

      * @return DataDictionaryService

      */

     public DataDictionaryService getDataDictionaryService() {

         return dataDictionaryService;

     }

     /**

      * @param dataDictionaryService

      */

     public void setDataDictionaryService(DataDictionaryService dataDictionaryService) {

         this.dataDictionaryService = dataDictionaryService;

     }

 }