/*

  * Copyright 2005-2007 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.web.struts.action;

 import java.io.ByteArrayOutputStream;

 import java.io.IOException;

 import java.lang.reflect.Method;

 import java.util.Collections;

 import java.util.List;

 import java.util.Map;

 import javax.servlet.http.HttpServletRequest;

 import javax.servlet.http.HttpServletResponse;

 import org.apache.commons.lang.StringUtils;

 import org.apache.struts.action.ActionForm;

 import org.apache.struts.action.ActionForward;

 import org.apache.struts.action.ActionMapping;

 import org.apache.struts.action.RedirectingActionForward;

 import org.kuali.rice.core.util.RiceConstants;

 import org.kuali.rice.kim.service.KIMServiceLocator;

 import org.kuali.rice.kim.util.KimCommonUtils;

 import org.kuali.rice.kim.util.KimConstants;

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

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

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

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

 import org.kuali.rice.kns.datadictionary.BusinessObjectEntry;

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

 import org.kuali.rice.kns.inquiry.Inquirable;

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

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

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

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

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

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

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

 import org.kuali.rice.kns.web.struts.form.InquiryForm;

 import org.kuali.rice.kns.web.ui.Field;

 import org.kuali.rice.kns.web.ui.Row;

 import org.kuali.rice.kns.web.ui.Section;

 /**

  * This class handles actions for inquiries of business objects.

  */

 public class KualiInquiryAction extends KualiAction {

     private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(KualiInquiryAction.class);

     private NoteService noteService;

     @Override

     protected void checkAuthorization(ActionForm form, String methodToCall) throws AuthorizationException {

         if (!(form instanceof InquiryForm)) {

             super.checkAuthorization(form, methodToCall);

         } else {

             try {

                     if(!KNSConstants.DOWNLOAD_BO_ATTACHMENT_METHOD.equals(methodToCall)){        

                             Class businessObjectClass = Class.forName(((InquiryForm) form).getBusinessObjectClassName());

                             if (!KIMServiceLocator.getIdentityManagementService().isAuthorizedByTemplateName(GlobalVariables.getUserSession().getPrincipalId(), KNSConstants.KNS_NAMESPACE, KimConstants.PermissionTemplateNames.INQUIRE_INTO_RECORDS, KimCommonUtils.getNamespaceAndComponentSimpleName(businessObjectClass), null)) {

                                     throw new AuthorizationException(GlobalVariables.getUserSession().getPerson().getPrincipalName(), 

                                     "inquire",

                                     businessObjectClass.getSimpleName());

                             }

                     }

             }

             catch (ClassNotFoundException e) {

                     LOG.warn("Unable to load BusinessObject class: " + ((InquiryForm) form).getBusinessObjectClassName(), e);

                 super.checkAuthorization(form, methodToCall);

             }

         }

     }

     @Override

         protected Map<String, String> getRoleQualification(ActionForm form,

                         String methodToCall) {

                 Map<String, String> roleQualification = super.getRoleQualification(

                                 form, methodToCall);

                 if (form instanceof InquiryForm) {

                         Map<String, String> primaryKeys = ((InquiryForm) form)

                                         .getInquiryPrimaryKeys();

                         if (primaryKeys != null) {

                                 for (String keyName : primaryKeys.keySet()) {

                                         roleQualification.put(keyName, primaryKeys.get(keyName));                                        

                                 }

                         }

                 }

                 return roleQualification;

         }

         @Override

     public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {

         request.setAttribute(KNSConstants.PARAM_MAINTENANCE_VIEW_MODE, KNSConstants.PARAM_MAINTENANCE_VIEW_MODE_INQUIRY);

         return super.execute(mapping, form, request, response);

     }

     /**

      * Gets an inquirable impl from the impl service name parameter. Then calls lookup service to retrieve the record from the

      * key/value parameters. Finally gets a list of Rows from the inquirable

      */

     public ActionForward start(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {

         InquiryForm inquiryForm = (InquiryForm) form;

         if (inquiryForm.getBusinessObjectClassName() == null) {

             LOG.error("Business object name not given.");

             throw new RuntimeException("Business object name not given.");

         }

         Class boClass = Class.forName(inquiryForm.getBusinessObjectClassName());

         ModuleService responsibleModuleService = KNSServiceLocator.getKualiModuleService().getResponsibleModuleService(boClass);

                 if(responsibleModuleService!=null && responsibleModuleService.isExternalizable(boClass)){

                         String redirectUrl = responsibleModuleService.getExternalizableBusinessObjectInquiryUrl(boClass, (Map<String, String[]>) request.getParameterMap());

                         ActionForward redirectingActionForward = new RedirectingActionForward(redirectUrl);

                         redirectingActionForward.setModule("/");

                         return redirectingActionForward;

                 }

                 return continueWithInquiry(mapping, form, request, response);

     }

     public ActionForward downloadCustomBOAttachment(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {

             String fileName = request.getParameter(KNSConstants.BO_ATTACHMENT_FILE_NAME);

                 String contentType = request.getParameter(KNSConstants.BO_ATTACHMENT_FILE_CONTENT_TYPE);

                 String fileContentBoField = request.getParameter(KNSConstants.BO_ATTACHMENT_FILE_CONTENT_FIELD);

             //require certain request properties

             if (fileName != null

                             && contentType != null

                             && fileContentBoField != null) {

                     //make sure user has authorization to download attachment

                     checkAuthorization(form, findMethodToCall(form, request));

                     fileName = StringUtils.replace(fileName, " ", "_");

                     InquiryForm inquiryForm = (InquiryForm) form;

                 BusinessObject bo = retrieveBOFromInquirable(inquiryForm);

                     checkBO(bo);

                     Class clazz = (bo.getClass());

                     Method method = clazz.getMethod("get"+StringUtils.capitalize(fileContentBoField));

                     byte[] fileContents = (byte[]) method.invoke(bo);

                     streamToResponse(fileContents, fileName, contentType,response);

             } else {

                     if (fileName == null) {

                             LOG.error("Request Parameter \""+ KNSConstants.BO_ATTACHMENT_FILE_NAME + "\" not provided.");

                     }

                     if (contentType == null) {

                             LOG.error("Request Parameter \""+ KNSConstants.BO_ATTACHMENT_FILE_CONTENT_TYPE + "\" not provided.");

                     }

                     if (fileContentBoField == null) {

                             LOG.error("Request Parameter \""+ KNSConstants.BO_ATTACHMENT_FILE_CONTENT_FIELD + "\" not provided.");

                     }

             }

             return null;

     }

     /**

      * Downloads the selected attachment to the user's browser

      *

      * @param mapping

      * @param form

      * @param request

      * @param response

      * @return ActionForward

      * @throws Exception

      */

     public ActionForward downloadBOAttachment(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {

         Long noteIdentifier = Long.valueOf(request.getParameter(KNSConstants.NOTE_IDENTIFIER));

         Note note = this.getNoteService().getNoteByNoteId(noteIdentifier);

         if(note != null){

                 Attachment attachment = note.getAttachment();

                 if(attachment != null){

                         //make sure attachment is setup with backwards reference to note (rather then doing this we could also just call the attachment service (with a new method that took in the note)

                         attachment.setNote(note);

                         WebUtils.saveMimeInputStreamAsFile(response, attachment.getAttachmentMimeTypeCode(), attachment.getAttachmentContents(), attachment.getAttachmentFileName(), attachment.getAttachmentFileSize().intValue());

                 }

                 return null;

         }

         return mapping.findForward(RiceConstants.MAPPING_BASIC);

     }

     public ActionForward continueWithInquiry(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {

             InquiryForm inquiryForm = (InquiryForm) form;

             if (inquiryForm.getBusinessObjectClassName() == null) {

                     LOG.error("Business object name not given.");

                     throw new RuntimeException("Business object name not given.");

             }

         BusinessObject bo = retrieveBOFromInquirable(inquiryForm);

         checkBO(bo);

         populateSections(mapping, request, inquiryForm, bo);

         return mapping.findForward(RiceConstants.MAPPING_BASIC);

     }

     /**

      * Turns on (or off) the inactive record display for a maintenance collection.

      */

     public ActionForward toggleInactiveRecordDisplay(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {

         InquiryForm inquiryForm = (InquiryForm) form;

         if (inquiryForm.getBusinessObjectClassName() == null) {

             LOG.error("Business object name not given.");

             throw new RuntimeException("Business object name not given.");

         }

         BusinessObject bo = retrieveBOFromInquirable(inquiryForm);

         checkBO(bo);

         Inquirable kualiInquirable = inquiryForm.getInquirable();

         //////////////////////////////

         String collectionName = extractCollectionName(request, KNSConstants.TOGGLE_INACTIVE_METHOD);

         if (collectionName == null) {

             LOG.error("Unable to get find collection name in request.");

             throw new RuntimeException("Unable to get find collection class in request.");

         }  

         String parameterName = (String) request.getAttribute(KNSConstants.METHOD_TO_CALL_ATTRIBUTE);

         boolean showInactive = Boolean.parseBoolean(StringUtils.substringBetween(parameterName, KNSConstants.METHOD_TO_CALL_BOPARM_LEFT_DEL, "."));

         kualiInquirable.setShowInactiveRecords(collectionName, showInactive);

         //////////////////////////////

         populateSections(mapping, request, inquiryForm, bo);

         if (showInactive) {

                 reopenInactiveRecords(inquiryForm, collectionName);

         }

         return mapping.findForward(RiceConstants.MAPPING_BASIC);

     }

     /**

      * Attempts to reopen sub tabs which would have been closed for inactive records

      * 

      * @param inquiryForm the form to reopen records on

      * @param collectionName the name of the collection reopening

      */

     protected void reopenInactiveRecords(InquiryForm inquiryForm, String collectionName) {

             for (Object sectionAsObject : inquiryForm.getSections()) {

                     final Section section = (Section)sectionAsObject;

                     for (Row row: section.getRows()) {

                             for (Field field : row.getFields()) {

                                     if (field.getFieldType().equals(Field.CONTAINER) && field.getContainerName().startsWith(collectionName)) {

                                             final String tabKey = WebUtils.generateTabKey(generateCollectionSubTabName(field));

                                             inquiryForm.getTabStates().put(tabKey, "OPEN");

                                     }

                             }

                     }

             }

     }

     /**

      * Finds a container field's sub tab name

      * 

      * @param field the collection sub tab name to  

      * @return the sub tab name

      */

     protected String generateCollectionSubTabName(Field field) {

             final String containerName = field.getContainerElementName();

             final String cleanedContainerName = 

                     (containerName == null) ?

                                     "" :

                                     containerName.replaceAll("\\d+", "");

             StringBuilder subTabName = new StringBuilder(cleanedContainerName);

             for (Field containerField : field.getContainerDisplayFields()) {

                     subTabName.append(containerField.getPropertyValue());

             }

             return subTabName.toString();

     }

     @Override

     public ActionForward toggleTab(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {

         InquiryForm inquiryForm = (InquiryForm) form;

         if (inquiryForm.getBusinessObjectClassName() == null) {

             LOG.error("Business object name not given.");

             throw new RuntimeException("Business object name not given.");

         }

         BusinessObject bo = retrieveBOFromInquirable(inquiryForm);

         checkBO(bo);

         populateSections(mapping, request, inquiryForm, bo);

         Inquirable kualiInquirable = inquiryForm.getInquirable();

         return super.toggleTab(mapping, form, request, response);

     }

     /**

          * @see org.kuali.rice.kns.web.struts.action.KualiAction#hideAllTabs(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

          */

         @Override

         public ActionForward hideAllTabs(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {

         // KULRICE-2852: Overrides hideAllTabs() so that it also calls the populateSections() method.

                 InquiryForm inquiryForm = (InquiryForm) form;

         if (inquiryForm.getBusinessObjectClassName() == null) {

             LOG.error("Business object name not given.");

             throw new RuntimeException("Business object name not given.");

         }

         BusinessObject bo = retrieveBOFromInquirable(inquiryForm);

         checkBO(bo);

         populateSections(mapping, request, inquiryForm, bo);

                 return super.hideAllTabs(mapping, form, request, response);

         }

         /**

          * @see org.kuali.rice.kns.web.struts.action.KualiAction#showAllTabs(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

          */

         @Override

         public ActionForward showAllTabs(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {

         // KULRICE-2852: Overrides showAllTabs() so that it also calls the populateSections() method.

                 InquiryForm inquiryForm = (InquiryForm) form;

         if (inquiryForm.getBusinessObjectClassName() == null) {

             LOG.error("Business object name not given.");

             throw new RuntimeException("Business object name not given.");

         }

         BusinessObject bo = retrieveBOFromInquirable(inquiryForm);

         checkBO(bo);

         populateSections(mapping, request, inquiryForm, bo);

                 return super.showAllTabs(mapping, form, request, response);

         }

         /**

      * Handles exporting the BusinessObject for this Inquiry to XML if it has a custom XML exporter available.

      */

     public ActionForward export(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {

             InquiryForm inquiryForm = (InquiryForm) form;

             if (inquiryForm.isCanExport()) {

                     BusinessObject bo = retrieveBOFromInquirable(inquiryForm);

                     checkBO(bo);

                     if (bo != null) {

                             BusinessObjectEntry businessObjectEntry = KNSServiceLocator.getDataDictionaryService().getDataDictionary().getBusinessObjectEntry(inquiryForm.getBusinessObjectClassName());

                             Class<? extends Exporter> exporterClass = businessObjectEntry.getExporterClass();

                             if (exporterClass != null) {

                                     Exporter exporter = exporterClass.newInstance();

                                 response.setContentType(KNSConstants.XML_MIME_TYPE);

                                 response.setHeader("Content-disposition", "attachment; filename=export.xml");

                                 exporter.export(businessObjectEntry.getBusinessObjectClass(), Collections.singletonList(bo), KNSConstants.XML_FORMAT, response.getOutputStream());

                         }

                     } else {

                             //show the empty section with error

                             populateSections(mapping, request, inquiryForm, bo);

                             return mapping.findForward(RiceConstants.MAPPING_BASIC); 

                     }

         }

         return null;

     }

     /**

      * Convert a Request into a Map<String,String>. Technically, Request parameters do not neatly translate into a Map of Strings,

      * because a given parameter may legally appear more than once (so a Map of String[] would be more accurate.) This method should

      * be safe for business objects, but may not be reliable for more general uses.

      */

     protected String extractCollectionName(HttpServletRequest request, String methodToCall) {

         // collection name and underlying object type from request parameter

         String parameterName = (String) request.getAttribute(KNSConstants.METHOD_TO_CALL_ATTRIBUTE);

         String collectionName = null;

         if (StringUtils.isNotBlank(parameterName)) {

             collectionName = StringUtils.substringBetween(parameterName, methodToCall + ".", ".(");

         }

         return collectionName;

     }

     protected BusinessObject retrieveBOFromInquirable(InquiryForm inquiryForm) {

             Inquirable kualiInquirable = inquiryForm.getInquirable();

         // retrieve the business object

         BusinessObject bo = kualiInquirable.getBusinessObject(inquiryForm.retrieveInquiryDecryptedPrimaryKeys());

         if (bo == null) {

             LOG.error("No records found in inquiry action.");

             GlobalVariables.getMessageMap().putError(KNSConstants.GLOBAL_ERRORS, RiceKeyConstants.ERROR_INQUIRY);

         }

         return bo;

     }

     protected void populateSections(ActionMapping mapping, HttpServletRequest request, InquiryForm inquiryForm, BusinessObject bo) {

             Inquirable kualiInquirable = inquiryForm.getInquirable();

             if (bo != null) {

                     // get list of populated sections for display

                     List sections = kualiInquirable.getSections(bo);

                 inquiryForm.setSections(sections);

                 kualiInquirable.addAdditionalSections(sections, bo);

             } else {

                     inquiryForm.setSections(getEmptySections(kualiInquirable.getTitle()));

             }

         request.setAttribute(KNSConstants.INQUIRABLE_ATTRIBUTE_NAME, kualiInquirable);

     }

     /**

     *

     * Handy method to stream the byte array to response object

     * @param attachmentDataSource

     * @param response

     * @throws Exception

     */

    protected void streamToResponse(byte[] fileContents, String fileName, String fileContentType,HttpServletResponse response) throws Exception{

        ByteArrayOutputStream baos = null;

        try{

            baos = new ByteArrayOutputStream(fileContents.length);

            baos.write(fileContents);

            WebUtils.saveMimeOutputStreamAsFile(response, fileContentType, baos, fileName);

        }finally{

            try{

                if(baos!=null){

                    baos.close();

                    baos = null;

                }

            }catch(IOException ioEx){

                LOG.error("Error while downloading attachment");

                throw new RuntimeException("IOException occurred while downloading attachment", ioEx);

            }

        }

    }

     /**

      * Returns a section list with one empty section and one row.

      * 

      * @return list of sections

      */

     private List<Section> getEmptySections(String title) {

             final Row row = new Row(Collections.<Field>emptyList());

             final Section section = new Section(Collections.singletonList(row));

                 section.setErrorKey("*");

                 section.setSectionTitle(title != null ? title : "");

                 section.setNumberOfColumns(0);

                 return Collections.singletonList(section);

     }

     /**

      * throws an exception if BO fails the check.

      * @param bo the BusinessObject to check.

      * @throws UnsupportedOperationException if BO is null & no messages have been generated.

      */

     private void checkBO(BusinessObject bo) {

         if (bo == null && GlobalVariables.getMessageMap().hasNoMessages()) {

                 throw new UnsupportedOperationException("The record you have inquired on does not exist.");

         }

     }

     protected NoteService getNoteService() {

                 if ( noteService == null ) {

                         noteService = KNSServiceLocator.getNoteService();

                 }

                 return this.noteService;

         }

 }