/*
    * Copyright (c) 2002-2021, City of 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.announce.business;
  
  import fr.paris.lutece.plugins.announce.service.AnnounceCacheService;
  import fr.paris.lutece.plugins.announce.service.AnnouncePlugin;
  import fr.paris.lutece.plugins.announce.service.announcesearch.AnnounceSearchService;
  import fr.paris.lutece.plugins.genericattributes.business.Response;
  import fr.paris.lutece.plugins.genericattributes.business.ResponseHome;
  import fr.paris.lutece.portal.business.file.FileHome;
  import fr.paris.lutece.portal.service.plugin.Plugin;
  import fr.paris.lutece.portal.service.plugin.PluginService;
  import fr.paris.lutece.portal.service.resource.ExtendableResourceRemovalListenerService;
  import fr.paris.lutece.portal.service.security.LuteceUser;
  import fr.paris.lutece.portal.service.spring.SpringContextService;
  import fr.paris.lutece.portal.service.workflow.WorkflowService;
  
  import java.sql.Timestamp;
  
  import java.util.ArrayList;
  import java.util.List;
  
  /**
   * This class provides instances management methods (create, find, ...) for Announce objects
   */
  public final class AnnounceHome
  {
      // Static variable pointed at the DAO instance
      private static IAnnounceDAO _dao = SpringContextService.getBean( "announce.announceDAO" );
      private static Plugin _plugin = PluginService.getPlugin( AnnouncePlugin.PLUGIN_NAME );
  
      /**
       * Private constructor - this class need not be instantiated
       */
      private AnnounceHome( )
      {
      }
  
      /**
       * Create an instance of the announce class
       * 
       * @return The instance of announce which has been created with its primary key.
       * @param announce
       *            The instance of the Announce which contains the informations to store
       */
      public static Announce../../../../../../fr/paris/lutece/plugins/announce/business/Announce.html#Announce">Announce create( Announce announce )
      {
          announce.setDateModification( new Timestamp( System.currentTimeMillis( ) ) );
          updateAnnouncePublicationTime( announce );
          _dao.insert( announce, _plugin );
  
          if ( announce.getPublished( ) && !announce.getSuspended( ) && !announce.getSuspendedByUser( ) )
          {
              AnnounceSearchService.getInstance( ).addIndexerAction( announce.getId( ), IndexerAction.TASK_CREATE, _plugin );
              AnnounceCacheService.getService( ).removeKey( AnnounceCacheService.getListIdPublishedAnnouncesCacheKey( ) );
          }
  
          return announce;
      }
  
      /**
       * Update of the announce which is specified in parameter
       * 
       * @return The instance of the announce which has been updated
       * @param announce
       *            The instance of the Announce which contains the data to store
       */
      public static Announce../../../../../../fr/paris/lutece/plugins/announce/business/Announce.html#Announce">Announce update( Announce announce )
     {
         announce.setDateModification( new Timestamp( System.currentTimeMillis( ) ) );
         _dao.store( announce, _plugin );
 
         if ( announce.getPublished( ) && !announce.getSuspended( ) && !announce.getSuspendedByUser( ) )
         {
             AnnounceSearchService.getInstance( ).addIndexerAction( announce.getId( ), IndexerAction.TASK_MODIFY, _plugin );
         }
         else
         {
             AnnounceSearchService.getInstance( ).addIndexerAction( announce.getId( ), IndexerAction.TASK_DELETE, _plugin );
         }
 
         AnnounceCacheService.getService( ).removeKey( AnnounceCacheService.getListIdPublishedAnnouncesCacheKey( ) );
         AnnounceCacheService.getService( ).putInCache( AnnounceCacheService.getAnnounceCacheKey( announce.getId( ) ), announce );
 
         return announce;
     }
 
     /**
      * Remove the announce whose identifier is specified in parameter and every response associated with it
      * 
      * @param nAnnounceId
      *            The announce Id
      */
     public static void remove( int nAnnounceId )
     {
         AnnounceSearchService.getInstance( ).addIndexerAction( nAnnounceId, IndexerAction.TASK_DELETE, _plugin );
 
         List<Integer> listIdResponse = findListIdResponse( nAnnounceId );
 
         for ( int nIdResponse : listIdResponse )
         {
             ResponseHome.remove( nIdResponse );
         }
 
         removeAnnounceResponse( nAnnounceId );
 
         ExtendableResourceRemovalListenerService.doRemoveResourceExtentions( Announce.RESOURCE_TYPE, Integer.toString( nAnnounceId ) );
 
         if ( WorkflowService.getInstance( ).isAvailable( ) )
         {
             WorkflowService.getInstance( ).doRemoveWorkFlowResource( nAnnounceId, Announce.RESOURCE_TYPE );
         }
 
         _dao.delete( nAnnounceId, _plugin );
         AnnounceCacheService.getService( ).removeKey( AnnounceCacheService.getListIdPublishedAnnouncesCacheKey( ) );
         AnnounceCacheService.getService( ).removeKey( AnnounceCacheService.getAnnounceCacheKey( nAnnounceId ) );
     }
 
     // /////////////////////////////////////////////////////////////////////////
     // Finders
 
     /**
      * Returns an instance of a announce whose identifier is specified in parameter
      * 
      * @param nKey
      *            The announce primary key
      * @return an instance of Announce
      */
     public static Announce findByPrimaryKey( int nKey )
     {
         Announce./../../../../fr/paris/lutece/plugins/announce/business/Announce.html#Announce">Announce announce = (Announce) AnnounceCacheService.getService( ).getFromCache( AnnounceCacheService.getAnnounceCacheKey( nKey ) );
 
         if ( announce == null )
         {
             announce = _dao.load( nKey, _plugin );
 
             if ( announce != null )
             {
                 AnnounceCacheService.getService( ).putInCache( AnnounceCacheService.getAnnounceCacheKey( announce.getId( ) ), announce );
             }
         }
 
         return announce;
     }
 
     /**
      * Returns the announce id from its image response id
      * 
      * @param nIdResponse
      *            the id of the response
      * @return The announce id, or null if there no announce that has this response as an image
      */
     public static Integer findIdByImageResponse( int nIdResponse )
     {
         return _dao.findIdByImageResponse( nIdResponse, _plugin );
     }
 
     /**
      * Load the data of all the announce objects and returns them in form of a list
      * 
      * @param announceSort
      *            The sort
      * @return the list which contains the data of all the announce objects
      */
     public static List<Integer> findAll( AnnounceSort announceSort )
     {
         return _dao.selectAll( announceSort, _plugin );
     }
 
     /**
      * Load the id of every published announce and returns them in form of a list
      * 
      * @param announceSort
      *            The sort
      * @return the list of id of every published announce
      */
     public static List<Integer> findAllPublishedId( AnnounceSort announceSort )
     {
         List<Integer> listIds = (List<Integer>) AnnounceCacheService.getService( ).getFromCache( AnnounceCacheService.getListIdPublishedAnnouncesCacheKey( ) );
 
         if ( listIds == null )
         {
             listIds = _dao.selectAllPublishedId( announceSort, _plugin );
             AnnounceCacheService.getService( ).putInCache( AnnounceCacheService.getListIdPublishedAnnouncesCacheKey( ), listIds );
         }
 
         return _dao.selectAllPublishedId( announceSort, _plugin );
     }
 
     /**
      * Load the data of all the announce objects and returns them in form of a list
      * 
      * @param announceSort
      *            The sort
      * @return the list which contains the data of all the announce objects
      */
     public static List<Announce> findAllPublished( AnnounceSort announceSort )
     {
         return _dao.selectAllPublished( announceSort, _plugin );
     }
 
     /**
      * Get the list of announces from a list of ids
      * 
      * @param listIdAnnounces
      *            The list of ids of announces to get
      * @param announceSort
      *            The sort
      * @return The list of announces
      */
     public static List<Announce> findByListId( List<Integer> listIdAnnounces, AnnounceSort announceSort )
     {
         return _dao.findByListId( listIdAnnounces, announceSort, _plugin );
     }
 
     /**
      * selects all the announces for a user
      * 
      * @param user
      *            the user
      * @param announceSort
      *            The sort
      * @return the list of announces
      */
     public static List<Announce> getAnnouncesForUser( LuteceUser user, AnnounceSort announceSort )
     {
         return _dao.selectAllForUser( user.getName( ), announceSort, _plugin );
     }
 
     /**
      * selects all the announces for a user
      * 
      * @param user
      *            the user name
      * @param announceSort
      *            The sort
      * @return the list of announces
      */
     public static List<Announce> getAnnouncesForUser( String user, AnnounceSort announceSort )
     {
         return _dao.selectAllForUser( user, announceSort, _plugin );
     }
 
     /**
      * selects all the announces for a category
      * 
      * @param category
      *            the category
      * @param announceSort
      *            The sort
      * @return the list of announces
      */
     public static List<Integer> getPublishedAnnouncesForCategory( Category category, AnnounceSort announceSort )
     {
         return _dao.selectAllPublishedForCategory( category, announceSort, _plugin );
     }
 
     /**
      * publish or unpublish an announce
      * 
      * @param announce
      *            the announce
      */
     public static void setPublished( Announce announce )
     {
         updateAnnouncePublicationTime( announce );
         _dao.setPublished( announce, _plugin );
 
         if ( announce.getPublished( ) && !announce.getSuspended( ) && !announce.getSuspendedByUser( ) )
         {
             AnnounceSearchService.getInstance( ).addIndexerAction( announce.getId( ), IndexerAction.TASK_CREATE, _plugin );
         }
         else
         {
             AnnounceSearchService.getInstance( ).addIndexerAction( announce.getId( ), IndexerAction.TASK_DELETE, _plugin );
         }
 
         AnnounceCacheService.getService( ).removeKey( AnnounceCacheService.getListIdPublishedAnnouncesCacheKey( ) );
         AnnounceCacheService.getService( ).removeKey( AnnounceCacheService.getAnnounceCacheKey( announce.getId( ) ) );
     }
 
     public static void setHasNotifed( Announce announce )
     {
         _dao.setHasNotifed( announce, _plugin );
 
         AnnounceCacheService.getService( ).removeKey( AnnounceCacheService.getAnnounceCacheKey( announce.getId( ) ) );
     }
 
     /**
      * suspend or UnSuspend an announce
      * 
      * @param announce
      *            the announce
      */
     public static void setSuspended( Announce announce )
     {
         updateAnnouncePublicationTime( announce );
         _dao.setSuspended( announce, _plugin );
 
         if ( announce.getPublished( ) && !announce.getSuspended( ) && !announce.getSuspendedByUser( ) )
         {
             AnnounceSearchService.getInstance( ).addIndexerAction( announce.getId( ), IndexerAction.TASK_CREATE, _plugin );
         }
         else
         {
             AnnounceSearchService.getInstance( ).addIndexerAction( announce.getId( ), IndexerAction.TASK_DELETE, _plugin );
         }
 
         AnnounceCacheService.getService( ).removeKey( AnnounceCacheService.getListIdPublishedAnnouncesCacheKey( ) );
         AnnounceCacheService.getService( ).removeKey( AnnounceCacheService.getAnnounceCacheKey( announce.getId( ) ) );
     }
 
     /**
      * suspend or UnSuspend an announce
      * 
      * @param announce
      *            the announce
      */
     public static void setSuspendedByUser( Announce announce )
     {
         updateAnnouncePublicationTime( announce );
         _dao.setSuspendedByUser( announce, _plugin );
 
         if ( announce.getPublished( ) && !announce.getSuspended( ) && !announce.getSuspendedByUser( ) )
         {
             AnnounceSearchService.getInstance( ).addIndexerAction( announce.getId( ), IndexerAction.TASK_CREATE, _plugin );
         }
         else
         {
             AnnounceSearchService.getInstance( ).addIndexerAction( announce.getId( ), IndexerAction.TASK_DELETE, _plugin );
         }
 
         AnnounceCacheService.getService( ).removeKey( AnnounceCacheService.getListIdPublishedAnnouncesCacheKey( ) );
         AnnounceCacheService.getService( ).removeKey( AnnounceCacheService.getAnnounceCacheKey( announce.getId( ) ) );
     }
 
     /**
      * Get the list of ids of announces that was created before the given date
      * 
      * @param timestamp
      *            The timestamp
      * @return The list of ids
      */
     public static List<Integer> findIdAnnouncesByDateCreation( Timestamp timestamp )
     {
         return _dao.findIdAnnouncesByDateCreation( timestamp, _plugin );
     }
 
     /**
      * Get the list of ids of announces that were created after a given time
      * 
      * @param lMinPublicationTime
      *            The minimum publication time of announces to get
      * @return The list of ids of announces
      */
     public static List<Integer> findIdAnnouncesByDatePublication( long lMinPublicationTime )
     {
         return _dao.findIdAnnouncesByDatePublication( lMinPublicationTime, _plugin );
     }
 
     // -----------------------------------------------
     // Announce response management
     // -----------------------------------------------
 
     /**
      * Associates a response to an Announce
      * 
      * @param nIdAnnounce
      *            The id of the announce
      * @param nIdResponse
      *            The id of the response
      * @param bIsImage
      *            True if the response is an image, false otherwise
      */
     public static void insertAnnounceResponse( int nIdAnnounce, int nIdResponse, boolean bIsImage )
     {
         _dao.insertAnnounceResponse( nIdAnnounce, nIdResponse, bIsImage, _plugin );
     }
 
     /**
      * Get the list of id of responses associated with an announce
      * 
      * @param nIdAnnounce
      *            the id of the announce
      * @return the list of responses, or an empty list if no response was found
      */
     public static List<Integer> findListIdResponse( int nIdAnnounce )
     {
         return _dao.findListIdResponse( nIdAnnounce, _plugin );
     }
 
     /**
      * Get the list of id of image responses associated with an announce
      * 
      * @param nIdAnnounce
      *            the id of the announce
      * @return the list of responses, or an empty list if no response was found
      */
     public static List<Integer> findListIdImageResponse( int nIdAnnounce )
     {
         return _dao.findListIdImageResponse( nIdAnnounce, _plugin );
     }
 
     /**
      * Get the list of responses associated with an announce
      * 
      * @param nIdAnnounce
      *            the id of the announce
      * @param bLoadFiles
      *            True to load files, false to ignore them. Note that physical files are never loaded by this method.
      * @return the list of responses, or an empty list if no response was found
      */
     public static List<Response> findListResponse( int nIdAnnounce, boolean bLoadFiles )
     {
         List<Integer> listIdResponse = findListIdResponse( nIdAnnounce );
         List<Response> listResponse = new ArrayList<>( listIdResponse.size( ) );
 
         for ( Integer nIdResponse : listIdResponse )
         {
             Response response = ResponseHome.findByPrimaryKey( nIdResponse );
             
             if ( response != null )
             {
                 if ( bLoadFiles && ( response.getFile( ) != null ) )
                 {
                     response.setFile( FileHome.findByPrimaryKey( response.getFile( ).getIdFile( ) ) );
                 }
 
                 listResponse.add( response );
             }
         }
 
         return listResponse;
     }
 
     /**
      * Remove the association between an announce and responses
      * 
      * @param nIdAnnounce
      *            The id of the announce
      */
     public static void removeAnnounceResponse( int nIdAnnounce )
     {
         _dao.deleteAnnounceResponse( nIdAnnounce, _plugin );
     }
 
     /**
      * Update the publication time of an announce according to its published, its suspended and its suspended by user parameters.<br />
      * Note that the announce is not flushed in the database
      * 
      * @param announce
      *            the announce to update
      */
     private static void updateAnnouncePublicationTime( Announce announce )
     {
         if ( announce.getPublished( ) && !announce.getSuspended( ) && !announce.getSuspendedByUser( ) )
         {
             announce.setTimePublication( System.currentTimeMillis( ) );
         }
     }
 }