/*
    * Copyright (c) 2002-2018, 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.directory.modules.multiview.web.record.filter.display.impl;
  
  import java.util.Comparator;
  import java.util.LinkedHashMap;
  import java.util.List;
  import java.util.Map;
  
  import javax.servlet.http.HttpServletRequest;
  
  import org.apache.commons.lang.StringUtils;
  
  import fr.paris.lutece.plugins.directory.business.DirectoryFilter;
  import fr.paris.lutece.plugins.directory.business.DirectoryHome;
  import fr.paris.lutece.plugins.directory.business.Directory;
  import fr.paris.lutece.plugins.directory.modules.multiview.service.DirectoryMultiviewPlugin;
  import fr.paris.lutece.plugins.directory.modules.multiview.util.RecordDirectoryNameConstants;
  import fr.paris.lutece.plugins.directory.modules.multiview.util.ReferenceListFactory;
  import fr.paris.lutece.plugins.directory.service.DirectoryResourceIdService;
  import fr.paris.lutece.portal.service.admin.AdminUserService;
  import fr.paris.lutece.portal.service.rbac.RBACService;
  import fr.paris.lutece.portal.service.template.AppTemplateService;
  import fr.paris.lutece.util.ReferenceList;
  import fr.paris.lutece.util.html.HtmlTemplate;
  import java.util.ArrayList;
  
  /**
   * Implementation of the IRecordFilterDisplay interface for the filter on directory
   */
  public class RecordFilterDisplayDirectory extends AbstractRecordFilterDisplay
  {
      // Templates
      private static final String DIRECTORY_FILTER_TEMPLATE_NAME = "admin/plugins/directory/modules/multiview/filter/record_directory_filter.html";
  
      // Constants
      private static final String DIRECTORY_CODE_ATTRIBUTE = "idDirectory";
      private static final String DIRECTORY_NAME_ATTRIBUTE = "title";
      private static final String DEFAULT_ID_DIRECTORY = "-1";
  
      /**
       * {@inheritDoc}
       */
      @Override
      public String getParameterName( )
      {
          return RecordDirectoryNameConstants.PARAMETER_ID_DIRECTORY;
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public Map<String, Object> getFilterDisplayMapValues( HttpServletRequest request )
      {
          String strIdDirectoryValue = DEFAULT_ID_DIRECTORY;
          Map<String, Object> mapFilterNameValues = new LinkedHashMap<>( );
  
          String strIdDirectory = request.getParameter( RecordDirectoryNameConstants.PARAMETER_ID_DIRECTORY );
          if ( StringUtils.isNotBlank( strIdDirectory ) )
          {
              mapFilterNameValues.put( RecordDirectoryNameConstants.FILTER_ID_DIRECTORY, strIdDirectory );
              strIdDirectoryValue = strIdDirectory;
          }
  
          setValue( strIdDirectoryValue );
  
          return mapFilterNameValues;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void buildTemplate( HttpServletRequest request )
     {
         String strTemplateResult = StringUtils.EMPTY;
 
         Map<String, Object> model = new LinkedHashMap<>( );
         model.put( MARK_FILTER_LIST, createReferenceList( request ) );
         model.put( MARK_FILTER_LIST_VALUE, getValue( ) );
         model.put( MARK_FILTER_NAME, RecordDirectoryNameConstants.PARAMETER_ID_DIRECTORY );
         model.put( RecordDirectoryNameConstants.PARAMETER_PREVIOUS_ID_DIRECTORY, request.getParameter( RecordDirectoryNameConstants.PARAMETER_ID_DIRECTORY ) );
 
         HtmlTemplate htmlTemplate = AppTemplateService.getTemplate( DIRECTORY_FILTER_TEMPLATE_NAME, request.getLocale( ), model );
         if ( htmlTemplate != null )
         {
             strTemplateResult = htmlTemplate.getHtml( );
         }
 
         setTemplate( strTemplateResult );
     }
 
     /**
      * Create the ReferenceList of the available directories on which we can filter
      * 
      * @return the ReferenceList of Directory on which we can filter
      */
     private ReferenceList createReferenceList( HttpServletRequest request )
     {
         ReferenceListFactory referenceListFactory = new ReferenceListFactory( getDirectoryList( request ), DIRECTORY_CODE_ATTRIBUTE, DIRECTORY_NAME_ATTRIBUTE );
 
         return referenceListFactory.createReferenceList( );
     }
 
     /**
      * Return the list of all Directory associated to a workflow
      * 
      * @return the list of all Directory associated to a workflow
      */
     private List<Directory> getDirectoryList( HttpServletRequest request )
     {
         DirectoryFilter filter = new DirectoryFilter( );
 
         List<Directory> listDirectory = DirectoryHome.getDirectoryList( filter, DirectoryMultiviewPlugin.getPlugin( ) );
 
         List<Directory> listAuthorizedDirectory = new ArrayList<>( RBACService.getAuthorizedCollection( listDirectory,
                 DirectoryResourceIdService.PERMISSION_VISUALISATION_RECORD, AdminUserService.getAdminUser( request ) ) );
 
         if ( listAuthorizedDirectory != null && !listAuthorizedDirectory.isEmpty( ) )
         {
 
             listAuthorizedDirectory.sort( Comparator.comparing( fr.paris.lutece.plugins.directory.business.Directory::getTitle,
                     Comparator.nullsLast( Comparator.naturalOrder( ) ) ) );
         }
 
         return listAuthorizedDirectory;
     }
 }