/*
    * Copyright (c) 2002-2022, 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.portal.business.mailinglist;
  
  import fr.paris.lutece.util.sql.DAOUtil;
  
  import java.sql.Statement;
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.List;
  
  /**
   * This class provides Data Access methods for MailingList objects
   */
  public final class MailingListDAO implements IMailingListDAO
  {
      // Constants
      private static final String SQL_QUERY_SELECT = "SELECT id_mailinglist, name, description, workgroup FROM core_admin_mailinglist WHERE id_mailinglist = ?";
      private static final String SQL_QUERY_INSERT = "INSERT INTO core_admin_mailinglist ( name, description, workgroup ) VALUES ( ?, ?, ? ) ";
      private static final String SQL_QUERY_DELETE = "DELETE FROM core_admin_mailinglist WHERE id_mailinglist = ? ";
      private static final String SQL_QUERY_UPDATE = "UPDATE core_admin_mailinglist SET id_mailinglist = ?, name = ?, description = ?, workgroup = ? WHERE id_mailinglist = ?";
      private static final String SQL_QUERY_SELECTALL = "SELECT id_mailinglist, name, description, workgroup FROM core_admin_mailinglist";
      private static final String SQL_QUERY_SELECT_BY_WORKGROUP = "SELECT id_mailinglist, name, description, workgroup FROM core_admin_mailinglist WHERE workgroup = ? ";
  
      // filters
      private static final String SQL_QUERY_FILTERS_INSERT = "INSERT INTO core_admin_mailinglist_filter ( id_mailinglist, workgroup, role ) VALUES ( ?, ?, ? ) ";
      private static final String SQL_QUERY_FILTERS_DELETE = "DELETE FROM core_admin_mailinglist_filter WHERE id_mailinglist = ? ";
      private static final String SQL_QUERY_FILTERS_DELETE_FILTER = "DELETE FROM core_admin_mailinglist_filter WHERE id_mailinglist = ? AND workgroup = ? AND role = ? ";
      private static final String SQL_QUERY_FILTERS_SELECTALL = "SELECT id_mailinglist, workgroup, role FROM core_admin_mailinglist_filter WHERE id_mailinglist = ?";
      private static final String SQL_QUERY_FILTERS_SELECT = "SELECT id_mailinglist, workgroup, role FROM core_admin_mailinglist_filter WHERE id_mailinglist = ? AND workgroup = ? AND role = ?";
  
      /**
       * Insert a new record in the table.
       *
       * @param mailingList
       *            instance of the MailingList object to insert
       */
      @Override
      public void insert( MailingList mailingList )
      {
          try ( DAOUtil/DAOUtil.html#DAOUtil">DAOUtil daoUtil = new DAOUtil( SQL_QUERY_INSERT, Statement.RETURN_GENERATED_KEYS ) )
          {
              int nIndex = 1;
              daoUtil.setString( nIndex++, mailingList.getName( ) );
              daoUtil.setString( nIndex++, mailingList.getDescription( ) );
              daoUtil.setString( nIndex, mailingList.getWorkgroup( ) );
  
              daoUtil.executeUpdate( );
  
              if ( daoUtil.nextGeneratedKey( ) )
              {
                  mailingList.setId( daoUtil.getGeneratedKeyInt( 1 ) );
              }
          }
      }
  
      /**
       * Load the data of the mailingList from the table
       *
       * @param nId
       *            The identifier of the mailingList
       * @return the instance of the MailingList
       */
      @Override
      public MailingList load( int nId )
      {
          MailingList mailinglist = null;
          try ( DAOUtil/DAOUtil.html#DAOUtil">DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT ) )
         {
             daoUtil.setInt( 1, nId );
             daoUtil.executeQuery( );
 
             if ( daoUtil.next( ) )
             {
                 mailinglist = new MailingList( );
 
                 mailinglist.setId( daoUtil.getInt( 1 ) );
                 mailinglist.setName( daoUtil.getString( 2 ) );
                 mailinglist.setDescription( daoUtil.getString( 3 ) );
                 mailinglist.setWorkgroup( daoUtil.getString( 4 ) );
             }
 
         }
 
         // load filters
         selectMailingListUsersFilters( mailinglist );
 
         return mailinglist;
     }
 
     /**
      * Delete a record from the table
      *
      * @param nMailingListId
      *            The identifier of the mailingList
      */
     @Override
     public void delete( int nMailingListId )
     {
         try ( DAOUtil/DAOUtil.html#DAOUtil">DAOUtil daoUtil = new DAOUtil( SQL_QUERY_DELETE ) )
         {
             daoUtil.setInt( 1, nMailingListId );
             daoUtil.executeUpdate( );
         }
 
         // delete filters
         deleteFilters( nMailingListId );
     }
 
     /**
      * Update the record in the table
      *
      * @param mailingList
      *            The reference of the mailingList
      */
     @Override
     public void store( MailingList mailingList )
     {
         try ( DAOUtil/DAOUtil.html#DAOUtil">DAOUtil daoUtil = new DAOUtil( SQL_QUERY_UPDATE ) )
         {
 
             daoUtil.setInt( 1, mailingList.getId( ) );
             daoUtil.setString( 2, mailingList.getName( ) );
             daoUtil.setString( 3, mailingList.getDescription( ) );
             daoUtil.setString( 4, mailingList.getWorkgroup( ) );
             daoUtil.setInt( 5, mailingList.getId( ) );
 
             daoUtil.executeUpdate( );
         }
     }
 
     /**
      * Load the data of all the mailingLists and returns them in form of a collection
      *
      * @return The Collection which contains the data of all the mailingLists
      */
     @Override
     public Collection<MailingList> selectAll( )
     {
         Collection<MailingList> mailingListList = new ArrayList<>( );
         try ( DAOUtil/DAOUtil.html#DAOUtil">DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECTALL ) )
         {
             daoUtil.executeQuery( );
 
             while ( daoUtil.next( ) )
             {
                 MailingListmailinglist/MailingList.html#MailingList">MailingList mailingList = new MailingList( );
 
                 mailingList.setId( daoUtil.getInt( 1 ) );
                 mailingList.setName( daoUtil.getString( 2 ) );
                 mailingList.setDescription( daoUtil.getString( 3 ) );
                 mailingList.setWorkgroup( daoUtil.getString( 4 ) );
 
                 mailingListList.add( mailingList );
             }
 
         }
 
         return mailingListList;
     }
 
     /**
      * Returns all mailing lists having a scope restricted to a given workgroup
      *
      * @param strWorkgroup
      *            The workgroup
      * @return the collection which contains the data of all the mailingLists
      */
     @Override
     public Collection<MailingList> selectByWorkgroup( String strWorkgroup )
     {
         Collection<MailingList> mailingListList = new ArrayList<>( );
         try ( DAOUtil/DAOUtil.html#DAOUtil">DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_BY_WORKGROUP ) )
         {
             daoUtil.setString( 1, strWorkgroup );
             daoUtil.executeQuery( );
 
             while ( daoUtil.next( ) )
             {
                 MailingListmailinglist/MailingList.html#MailingList">MailingList mailingList = new MailingList( );
 
                 mailingList.setId( daoUtil.getInt( 1 ) );
                 mailingList.setName( daoUtil.getString( 2 ) );
                 mailingList.setDescription( daoUtil.getString( 3 ) );
                 mailingList.setWorkgroup( daoUtil.getString( 4 ) );
 
                 mailingListList.add( mailingList );
             }
 
         }
 
         return mailingListList;
     }
 
     /**
      * Insert a new record in the table.
      *
      * @param nMailingListId
      *            The mailing list Id
      * @param mailingListUsersFilter
      *            instance of the MailingListUsersFilter object to insert
      */
     @Override
     public void insertFilter( MailingListUsersFilter mailingListUsersFilter, int nMailingListId )
     {
         try ( DAOUtil/DAOUtil.html#DAOUtil">DAOUtil daoUtil = new DAOUtil( SQL_QUERY_FILTERS_INSERT ) )
         {
 
             daoUtil.setInt( 1, nMailingListId );
             daoUtil.setString( 2, mailingListUsersFilter.getWorkgroup( ) );
             daoUtil.setString( 3, mailingListUsersFilter.getRole( ) );
 
             daoUtil.executeUpdate( );
         }
     }
 
     /**
      * Remove an users filter from the mailing list
      * 
      * @param nMailingListId
      *            The Id of the mailing list
      * @param filter
      *            the filter to remove
      */
     @Override
     public void deleteFilter( MailingListUsersFilter filter, int nMailingListId )
     {
         try ( DAOUtil/DAOUtil.html#DAOUtil">DAOUtil daoUtil = new DAOUtil( SQL_QUERY_FILTERS_DELETE_FILTER ) )
         {
             daoUtil.setInt( 1, nMailingListId );
             daoUtil.setString( 2, filter.getWorkgroup( ) );
             daoUtil.setString( 3, filter.getRole( ) );
             daoUtil.executeUpdate( );
         }
     }
 
     /**
      * Delete a record from the table
      *
      * @param nMailingListUsersFilterId
      *            The identifier of the mailingListUsersFilter
      */
     public void deleteFilters( int nMailingListUsersFilterId )
     {
         try ( DAOUtil/DAOUtil.html#DAOUtil">DAOUtil daoUtil = new DAOUtil( SQL_QUERY_FILTERS_DELETE ) )
         {
             daoUtil.setInt( 1, nMailingListUsersFilterId );
             daoUtil.executeUpdate( );
         }
     }
 
     /**
      * Load the data of all the mailingListUsersFilters and returns them in form of a collection
      * 
      * @param mailinglist
      *            The mailing list
      */
     public void selectMailingListUsersFilters( MailingList mailinglist )
     {
         if ( mailinglist != null )
         {
             Collection<MailingListUsersFilter> mailingListUsersFilterList = mailinglist.getFilters( );
             try ( DAOUtil/DAOUtil.html#DAOUtil">DAOUtil daoUtil = new DAOUtil( SQL_QUERY_FILTERS_SELECTALL ) )
             {
                 daoUtil.setInt( 1, mailinglist.getId( ) );
                 daoUtil.executeQuery( );
 
                 while ( daoUtil.next( ) )
                 {
                     MailingListUsersFiltertUsersFilter.html#MailingListUsersFilter">MailingListUsersFilter mailingListUsersFilter = new MailingListUsersFilter( );
 
                     mailingListUsersFilter.setWorkgroup( daoUtil.getString( 2 ) );
                     mailingListUsersFilter.setRole( daoUtil.getString( 3 ) );
 
                     mailingListUsersFilterList.add( mailingListUsersFilter );
                 }
 
             }
         }
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public boolean checkFilter( MailingListUsersFilter filter, int nId )
     {
         boolean bExists = false;
         try ( DAOUtil/DAOUtil.html#DAOUtil">DAOUtil daoUtil = new DAOUtil( SQL_QUERY_FILTERS_SELECT ) )
         {
             daoUtil.setInt( 1, nId );
             daoUtil.setString( 2, filter.getWorkgroup( ) );
             daoUtil.setString( 3, filter.getRole( ) );
             daoUtil.executeQuery( );
 
             if ( daoUtil.next( ) )
             {
                 bExists = true;
             }
 
         }
 
         return bExists;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public List<MailingList> selectByFilter( MailingListFilter filter )
     {
         List<MailingList> mailingListList = new ArrayList<>( );
         try ( DAOUtil/DAOUtil.html#DAOUtil">DAOUtil daoUtil = new DAOUtil( filter.buildSQLQuery( SQL_QUERY_SELECTALL ) ) )
         {
             filter.setFilterValues( daoUtil );
             daoUtil.executeQuery( );
 
             while ( daoUtil.next( ) )
             {
                 int nIndex = 1;
                 MailingListmailinglist/MailingList.html#MailingList">MailingList mailingList = new MailingList( );
 
                 mailingList.setId( daoUtil.getInt( nIndex++ ) );
                 mailingList.setName( daoUtil.getString( nIndex++ ) );
                 mailingList.setDescription( daoUtil.getString( nIndex++ ) );
                 mailingList.setWorkgroup( daoUtil.getString( nIndex ) );
 
                 mailingListList.add( mailingList );
             }
 
         }
 
         return mailingListList;
     }
 }