/*
    * Copyright (c) 2002-2014, Mairie de Paris
    * All rights reserved.
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met:
    *
    *  1. Redistributions of source code must retain the above copyright notice
   *     and the following disclaimer.
   *
   *  2. Redistributions in binary form must reproduce the above copyright notice
   *     and the following disclaimer in the documentation and/or other materials
   *     provided with the distribution.
   *
   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
   *     contributors may be used to endorse or promote products derived from
   *     this software without specific prior written permission.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   * POSSIBILITY OF SUCH DAMAGE.
   *
   * License 1.0
   */
  package fr.paris.lutece.plugins.formengine.web;
  
  import fr.paris.lutece.plugins.formengine.service.FormsRegistrationService;
  import fr.paris.lutece.plugins.formengine.util.JSONUtils;
  import fr.paris.lutece.portal.service.i18n.I18nService;
  import fr.paris.lutece.portal.service.util.AppLogService;
  import fr.paris.lutece.portal.web.upload.IAsynchronousUploadHandler;
  
  import net.sf.json.JSONObject;
  
  import org.apache.commons.fileupload.FileItem;
  import org.apache.commons.lang.StringUtils;
  
  import java.util.List;
  
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  
  
  /**
   * Handler for asynchronous uploads.
   * Files are stored using {@link SubForm#addFileItem(String, String, FileItem)}.
   * The <code>jessionid</code> parameter should be the <strong>REAL</strong> session id,
   * not the flash player one.
   * The uploaded files are deleted by SubForm when filling fields.
   *
   */
  public class FormengineAsynchronousUploadHandler implements IAsynchronousUploadHandler
  {
      private static final String PARAMETER_PAGE = "page";
      private static final String PARAMETER_FORM = "form";
      private static final String PARAMETER_SUBFORM = "subform";
      private static final String PARAMETER_FIELD_NAME = "fieldname";
      private static final String PARAMETER_JSESSION_ID = "jsessionid";
      private static final String PROPERTY_MESSAGE_ERROR_UPLOAD = "";
  
      /**
       * Invoked if <code>request.getParameter( {@link #PARAMETER_PAGE} ).equals {@link SharedConstants#PLUGIN_NAME}</code>
       */
      public boolean isInvoked( HttpServletRequest request )
      {
          return SharedConstants.PLUGIN_NAME.equals( request.getParameter( PARAMETER_PAGE ) );
      }
  
      /**
       * Gets the file(s) and associates them to the user "fake" session.
       * Checks if form/subform exists.
       * Adds the uploaded file list to the main object.
       */
      public void process( HttpServletRequest request, HttpServletResponse response, JSONObject mainObject,
          List<FileItem> listFileItems )
      {
          String strFormName = request.getParameter( PARAMETER_FORM );
          String strSubformName = request.getParameter( PARAMETER_SUBFORM );
          String strFieldName = request.getParameter( PARAMETER_FIELD_NAME );
          Form form = FormsRegistrationService.getForm( strFormName );
          String strSessionId = request.getParameter( PARAMETER_JSESSION_ID );
  
          // check session, form, subform
          if ( strSessionId == null )
          {
              AppLogService.error( "Session does not exists" );
              mainObject.accumulate( JSONUtils.JSON_KEY_ERROR,
                  I18nService.getLocalizedString( PROPERTY_MESSAGE_ERROR_UPLOAD, request.getLocale(  ) ) );
          }
          else if ( form == null )
         {
             mainObject.accumulate( JSONUtils.JSON_KEY_ERROR,
                 I18nService.getLocalizedString( PROPERTY_MESSAGE_ERROR_UPLOAD, request.getLocale(  ) ) );
         }
         else
         {
             SubForm subForm = null;
 
             if ( StringUtils.isNotBlank( strSubformName ) )
             {
                 subForm = form.getSubForm( strSubformName );
             }
 
             if ( subForm == null )
             {
                 // if upload is in first subform, no subform parameter available
                 subForm = form.getFirstSubForm(  );
             }
 
             // field name check cannot be performed
             for ( FileItem fileItem : listFileItems )
             {
                 // the uploaded file cannot be bound to the actual session
                 // due to flash player restrictions
                 subForm.addFileItem( strSessionId, strFieldName, fileItem );
             }
 
             // get the list of file in session for the given id to display the list
             List<FileItem> listSessionFileItems = subForm.getFileItems( strSessionId, strFieldName );
             JSONObject jsonListFileItems = JSONUtils.getUploadedFileJSON( listSessionFileItems );
             mainObject.accumulateAll( jsonListFileItems );
 
             mainObject.element( JSONUtils.JSON_KEY_FIELD, strFieldName );
         }
     }
 }