/*
    * Copyright 2006 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.ole.fp.document.service.impl;
  
  import java.io.IOException;
  import java.io.OutputStream;
  
  import org.kuali.ole.fp.businessobject.DisbursementVoucherDocumentationLocation;
  import org.kuali.ole.fp.businessobject.PaymentReasonCode;
  import org.kuali.ole.fp.businessobject.options.PaymentMethodValuesFinder;
  import org.kuali.ole.fp.document.DisbursementVoucherConstants;
  import org.kuali.ole.fp.document.DisbursementVoucherDocument;
  import org.kuali.ole.fp.document.service.DisbursementVoucherCoverSheetService;
  import org.kuali.rice.coreservice.framework.parameter.ParameterService;
  import org.kuali.rice.kew.api.WorkflowDocument;
  import org.kuali.rice.krad.service.BusinessObjectService;
  import org.kuali.rice.krad.service.PersistenceStructureService;
  import org.kuali.rice.krad.util.ObjectUtils;
  
  import com.lowagie.text.DocumentException;
  import com.lowagie.text.pdf.AcroFields;
  import com.lowagie.text.pdf.PdfReader;
  import com.lowagie.text.pdf.PdfStamper;
  
  /**
   * This is the default implementation of the DisbursementVoucherCoverSheetService interface.
   */
  public class DisbursementVoucherCoverSheetServiceImpl implements DisbursementVoucherCoverSheetService {
      private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(DisbursementVoucherCoverSheetServiceImpl.class);
  
      protected ParameterService parameterService;
      protected BusinessObjectService businessObjectService;
      protected PersistenceStructureService persistenceStructureService;
  
      /**
       * This method uses the values provided to build and populate a cover sheet associated with a given DisbursementVoucher.
       *
       * @param templateDirectory The directory where the cover sheet template can be found.
       * @param templateName The name of the cover sheet template to be used to build the cover sheet.
       * @param document The DisbursementVoucher the cover sheet will be populated from.
       * @param outputStream The stream the cover sheet file will be written to.
       * @see org.kuali.ole.fp.document.service.DisbursementVoucherCoverSheetService#generateDisbursementVoucherCoverSheet(java.lang.String,
       *      java.lang.String, org.kuali.ole.fp.document.DisbursementVoucherDocument, java.io.OutputStream)
       */
      @Override
      public void generateDisbursementVoucherCoverSheet(String templateDirectory, String templateName, DisbursementVoucherDocument document, OutputStream outputStream) throws DocumentException, IOException {
          if (this.isCoverSheetPrintable(document)) {
              String attachment = "";
              String handling = "";
              String alien = "";
              String lines = "";
              String bar = "";
              String rlines = "";
  
              String docNumber = document.getDocumentNumber();
              String initiator = document.getDocumentHeader().getWorkflowDocument().getInitiatorPrincipalId();
              String payee = document.getDvPayeeDetail().getDisbVchrPayeePersonName();
  
              String reason = businessObjectService.findBySinglePrimaryKey(PaymentReasonCode.class, document.getDvPayeeDetail().getDisbVchrPaymentReasonCode()).getName();
              String check_total = document.getDisbVchrCheckTotalAmount().toString();
  
              String currency = new PaymentMethodValuesFinder().getKeyLabel(document.getDisbVchrPaymentMethodCode());
  
              String address = retrieveAddress(document.getDisbursementVoucherDocumentationLocationCode());
  
              // retrieve attachment label
              if (document.isDisbVchrAttachmentCode()) {
                  attachment = parameterService.getParameterValueAsString(DisbursementVoucherDocument.class, DisbursementVoucherConstants.DV_COVER_SHEET_TEMPLATE_ATTACHMENT_PARM_NM);
              }
              // retrieve handling label
              if (document.isDisbVchrSpecialHandlingCode()) {
                  handling = parameterService.getParameterValueAsString(DisbursementVoucherDocument.class, DisbursementVoucherConstants.DV_COVER_SHEET_TEMPLATE_HANDLING_PARM_NM);
              }
              // retrieve data for alien payment code
              //Commented for the jira issue OLE-3415
              /*if (document.getDvPayeeDetail().isDisbVchrAlienPaymentCode()) {
                  String taxDocumentationLocationCode = parameterService.getParameterValueAsString(DisbursementVoucherDocument.class, DisbursementVoucherConstants.TAX_DOCUMENTATION_LOCATION_CODE_PARM_NM);
  
                  address = retrieveAddress(taxDocumentationLocationCode);
                  alien = parameterService.getParameterValueAsString(DisbursementVoucherDocument.class, DisbursementVoucherConstants.DV_COVER_SHEET_TEMPLATE_ALIEN_PARM_NM);
                  lines = parameterService.getParameterValueAsString(DisbursementVoucherDocument.class, DisbursementVoucherConstants.DV_COVER_SHEET_TEMPLATE_LINES_PARM_NM);
              }*/
  
              // determine if non-employee travel payment reasons
              String paymentReasonCode = document.getDvPayeeDetail().getDisbVchrPaymentReasonCode();
            //Commented for the jira issue OLE-3415
             /*ParameterEvaluator travelNonEmplPaymentReasonEvaluator = SpringContext.getBean(ParameterEvaluatorService.class).getParameterEvaluator(DisbursementVoucherDocument.class, DisbursementVoucherConstants.NONEMPLOYEE_TRAVEL_PAY_REASONS_PARM_NM, paymentReasonCode);
             boolean isTravelNonEmplPaymentReason = travelNonEmplPaymentReasonEvaluator.evaluationSucceeds();
 
             if (isTravelNonEmplPaymentReason) {
                 bar = parameterService.getParameterValueAsString(DisbursementVoucherDocument.class, DisbursementVoucherConstants.DV_COVER_SHEET_TEMPLATE_BAR_PARM_NM);
                 rlines = parameterService.getParameterValueAsString(DisbursementVoucherDocument.class, DisbursementVoucherConstants.DV_COVER_SHEET_TEMPLATE_RLINES_PARM_NM);
             }*/
 
             try {
                 PdfReader reader = new PdfReader(templateDirectory + templateName);
 
                 // populate form with document values
                 PdfStamper stamper = new PdfStamper(reader, outputStream);
 
                 AcroFields populatedCoverSheet = stamper.getAcroFields();
                 populatedCoverSheet.setField("initiator", initiator);
                 populatedCoverSheet.setField("attachment", attachment);
                 populatedCoverSheet.setField("currency", currency);
                 populatedCoverSheet.setField("handling", handling);
                 populatedCoverSheet.setField("alien", alien);
                 populatedCoverSheet.setField("payee_name", payee);
                 populatedCoverSheet.setField("check_total", check_total);
                 populatedCoverSheet.setField("docNumber", docNumber);
                 populatedCoverSheet.setField("payment_reason", reason);
                 populatedCoverSheet.setField("destination_address", address);
                 populatedCoverSheet.setField("lines", lines);
                 populatedCoverSheet.setField("bar", bar);
                 populatedCoverSheet.setField("rlines", rlines);
 
                 stamper.setFormFlattening(true);
                 stamper.close();
             }
             catch (DocumentException e) {
                 LOG.error("Error creating coversheet for: " + docNumber + ". ::" + e);
                 throw e;
             }
             catch (IOException e) {
                 LOG.error("Error creating coversheet for: " + docNumber + ". ::" + e);
                 throw e;
             }
         }
 
     }
 
     /**
      * @see org.kuali.ole.fp.document.service.DisbursementVoucherCoverSheetService#isCoverSheetPrintable(org.kuali.ole.fp.document.DisbursementVoucherDocument)
      */
     @Override
     public boolean isCoverSheetPrintable(DisbursementVoucherDocument document) {
         WorkflowDocument workflowDocument = document.getDocumentHeader().getWorkflowDocument();
 
         if(ObjectUtils.isNull(workflowDocument)){
             return false;
     }
 
         return !(workflowDocument.isCanceled() || workflowDocument.isInitiated() || workflowDocument.isDisapproved() || workflowDocument.isException() || workflowDocument.isDisapproved() || workflowDocument.isSaved());
     }
 
     /**
      * This method contains logic to determine the address the cover sheet should be sent to.
      *
      * @param docLocCd A key used to retrieve the document location.
      * @return The address the cover sheet will be sent to or empty string if no location is found.
      */
     protected String retrieveAddress(String docLocCd) {
         String address = "";
         try {
             address = businessObjectService.findBySinglePrimaryKey(DisbursementVoucherDocumentationLocation.class, docLocCd).getDisbursementVoucherDocumentationLocationAddress();
         }
         catch (NullPointerException e) {
             // ignored
         }
 
         return address;
     }
 
     // spring injected services
 
     /**
      * Sets the businessObjectService attribute value.
      *
      * @param businessObjectService The businessObjectService to set.
      */
     public void setBusinessObjectService(BusinessObjectService businessObjectService) {
         this.businessObjectService = businessObjectService;
     }
 
     /**
      * Sets the persistenceStructureService attribute value.
      *
      * @param persistenceStructureService The persistenceService to set.
      */
     public void setPersistenceStructureService(PersistenceStructureService persistenceStructureService) {
         this.persistenceStructureService = persistenceStructureService;
     }
 
     /**
      * Sets the parameterService attribute value.
      *
      * @param parameterService The parameterService to set.
      */
     public void setParameterService(ParameterService parameterService) {
         this.parameterService = parameterService;
     }
 }