BlogListPortletDAO.java

/*
 * Copyright (c) 2002-2020, 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.blog.business.portlet;

import fr.paris.lutece.portal.business.portlet.Portlet;
import fr.paris.lutece.portal.service.plugin.Plugin;
import fr.paris.lutece.util.ReferenceItem;
import fr.paris.lutece.util.ReferenceList;
import fr.paris.lutece.util.sql.DAOUtil;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * This class provides Data Access methods for BlogsListPortlet objects
 */
public final class BlogListPortletDAO implements IBlogListPortletDAO
{

    private static final String SQL_QUERY_SELECTALL = "SELECT id_portlet , id_page_template_document FROM blog_list_portlet ";
    private static final String SQL_QUERY_INSERT = "INSERT INTO blog_list_portlet ( id_portlet , id_page_template_document ) VALUES ( ? , ? )";
    private static final String SQL_QUERY_SELECT = "SELECT id_portlet , id_page_template_document FROM blog_list_portlet WHERE id_portlet = ? ";
    private static final String SQL_QUERY_UPDATE = "UPDATE blog_list_portlet SET id_portlet = ?, id_page_template_document = ? WHERE id_portlet = ? ";
    private static final String SQL_QUERY_DELETE = "DELETE FROM blog_list_portlet WHERE id_portlet= ? ";
    private static final String SQL_QUERY_CHECK_IS_ALIAS = "SELECT id_alias FROM core_portlet_alias WHERE id_alias = ?";

    private static final String SQL_QUERY_SELECT_PORTLET_BY_TYPE = "SELECT DISTINCT b.id_portlet , a.name, a.date_update " + "FROM blog_list_portlet b "
            + "LEFT JOIN blog_list_portlet_htmldocs c ON b.id_portlet = c.id_portlet AND c.id_blog= ? "
            + "INNER JOIN core_portlet a ON b.id_portlet = a.id_portlet " + "INNER JOIN core_page f ON a.id_page = f.id_page WHERE c.id_portlet IS NULL ";
    // Category
    private static final String SQL_QUERY_INSERT_BLOGS_PORTLET = "INSERT INTO blog_list_portlet_htmldocs ( id_portlet , id_blog, status, document_order ) VALUES ( ? , ?, ?, ? )";
    private static final String SQL_QUERY_INSERT_BLOGS_PORTLET_ON_UPDATE = "INSERT INTO blog_list_portlet_htmldocs ( id_portlet , id_blog, status, document_order, date_begin_publishing, date_end_publishing) VALUES ( ? , ?, ?, ?, ?, ? )";
    private static final String SQL_QUERY_DELETE_BLOGS_PORTLET = " DELETE FROM blog_list_portlet_htmldocs WHERE id_portlet = ? ";
    private static final String SQL_QUERY_SELECT_CATEGORY_PORTLET = "SELECT id_blog, document_order, date_begin_publishing, date_end_publishing, status FROM blog_list_portlet_htmldocs WHERE id_portlet = ? order by document_order ";
    private static final String SQL_QUERY_SELECT_PAGE_PORTLET = "SELECT id_page_template_document,description from  blog_page_template where portlet_type= ?";

    private static final String SQL_QUERY_SELECT_MIN_DOC_ORDER = "SELECT MIN( document_order ) FROM blog_list_portlet_htmldocs ";

    // /////////////////////////////////////////////////////////////////////////////////////
    // Access methods to data

    /**
     * {@inheritDoc }
     */
    @Override
    public void insert( Portlet portlet )
    {
        BlogListPortlet p = (BlogListPortlet) portlet;

        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_INSERT ) )
        {
            daoUtil.setInt( 1, p.getId( ) );
            daoUtil.setInt( 2, p.getPageTemplateDocument( ) );

            daoUtil.executeUpdate( );
        }

        insertBlogsId( portlet );
    }

    /**
     * Insert a list of doc for a specified portlet
     * 
     * @param portlet
     *            the DocumentListPortlet to insert
     */
    private void insertBlogsId( Portlet portlet )
    {
        BlogListPortlet p = (BlogListPortlet) portlet;

        if ( !p.getArrayBlogs( ).isEmpty( ) )
        {
            try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_INSERT_BLOGS_PORTLET ) )
            {

                for ( BlogPublication docPub : p.getArrayBlogs( ) )
                {
                    daoUtil.setInt( 1, p.getId( ) );
                    daoUtil.setInt( 2, docPub.getIdBlog( ) );
                    daoUtil.setInt( 3, 1 );
                    daoUtil.setInt( 4, docPub.getBlogOrder( ) );
                    daoUtil.executeUpdate( );
                }

            }
        }
    }

    /**
     * Insert a list of blog publication for a specified portlet
     * 
     * @param portlet
     *            the DocumentListPortlet to insert
     */
    private void insertBlogsPublicationOnUpdate( Portlet portlet )
    {
        BlogListPortlet p = (BlogListPortlet) portlet;

        if ( !p.getArrayBlogs( ).isEmpty( ) )
        {
            try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_INSERT_BLOGS_PORTLET_ON_UPDATE ) )
            {

                for ( BlogPublication docPub : p.getArrayBlogs( ) )
                {
                    daoUtil.setInt( 1, p.getId( ) );
                    daoUtil.setInt( 2, docPub.getIdBlog( ) );
                    daoUtil.setInt( 3, 1 );
                    daoUtil.setInt( 4, docPub.getBlogOrder( ) );
                    daoUtil.setDate( 5, docPub.getDateBeginPublishing( ) );
                    daoUtil.setDate( 6, docPub.getDateEndPublishing( ) );
                    daoUtil.executeUpdate( );
                }

            }
        }
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public void delete( int nPortletId )
    {
        deleteHtmlsDocsId( nPortletId );
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_DELETE ) )
        {
            daoUtil.setInt( 1, nPortletId );
            daoUtil.executeUpdate( );
        }

    }

    /**
     * Delete docs for the specified portlet
     * 
     * @param nPortletId
     *            The portlet identifier
     */
    private void deleteHtmlsDocsId( int nPortletId )
    {
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_DELETE_BLOGS_PORTLET ) )
        {
            daoUtil.setInt( 1, nPortletId );
            daoUtil.executeUpdate( );
        }
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public Portlet load( int nPortletId )
    {
        BlogListPortlet portlet = new BlogListPortlet( );
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT ) )
        {
            daoUtil.setInt( 1, nPortletId );
            daoUtil.executeQuery( );

            if ( daoUtil.next( ) )
            {
                portlet.setId( daoUtil.getInt( 1 ) );
                portlet.setPageTemplateDocument( daoUtil.getInt( 2 ) );
            }
        }

        portlet.setArrayBlogs( loadBlogsId( nPortletId ) );
        return portlet;
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public Map<Integer, String> loadPages( String strPortletType )
    {
        Map<Integer, String> page = new HashMap<>( );
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_PAGE_PORTLET ) )
        {
            daoUtil.setString( 1, strPortletType );
            daoUtil.executeQuery( );

            while ( daoUtil.next( ) )
            {
                page.put( daoUtil.getInt( 1 ), daoUtil.getString( 2 ) );
            }
        }
        return page;
    }

    /**
     * Load a list of Id Blogs
     * 
     * @param nPortletId
     * @return List of IdDoc
     */
    private List<BlogPublication> loadBlogsId( int nPortletId )
    {
        List<BlogPublication> listDocPublication = new ArrayList<>( );
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_CATEGORY_PORTLET ) )
        {
            daoUtil.setInt( 1, nPortletId );
            daoUtil.executeQuery( );

            while ( daoUtil.next( ) )
            {
                BlogPublication docPub = new BlogPublication( );
                docPub.setIdBlog( daoUtil.getInt( 1 ) );
                docPub.setBlogOrder( daoUtil.getInt( 2 ) );
                docPub.setDateBeginPublishing( daoUtil.getDate( 3 ) );
                docPub.setDateEndPublishing( daoUtil.getDate( 4 ) );
                docPub.setStatus( daoUtil.getInt( 5 ) );
                listDocPublication.add( docPub );

            }

        }
        return listDocPublication;
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public void store( Portlet portlet )
    {
        BlogListPortlet p = (BlogListPortlet) portlet;
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_UPDATE ) )
        {
            daoUtil.setInt( 1, p.getId( ) );
            daoUtil.setInt( 2, p.getPageTemplateDocument( ) );
            daoUtil.setInt( 3, p.getId( ) );

            daoUtil.executeUpdate( );
        }

        deleteHtmlsDocsId( p.getId( ) );
        insertBlogsPublicationOnUpdate( p );
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public boolean checkIsAliasPortlet( int nPortletId )
    {
        boolean bIsAlias = false;
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_CHECK_IS_ALIAS ) )
        {
            daoUtil.setInt( 1, nPortletId );
            daoUtil.executeQuery( );

            if ( daoUtil.next( ) )
            {
                bIsAlias = true;
            }
        }
        return bIsAlias;
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public ReferenceList selectBlogListPortletReferenceList( Plugin plugin )
    {
        ReferenceList blogPortletList = new ReferenceList( );
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECTALL, plugin ) )
        {
            daoUtil.executeQuery( );

            while ( daoUtil.next( ) )
            {
                blogPortletList.addItem( daoUtil.getInt( 1 ), daoUtil.getString( 2 ) );
            }

        }
        return blogPortletList;
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public Collection<ReferenceItem> selectPortletByType( int nDocumentId, PortletOrder pOrder, PortletFilter pFilter )
    {
        StringBuilder strSQl = new StringBuilder( );
        strSQl.append( SQL_QUERY_SELECT_PORTLET_BY_TYPE );

        String strFilter = ( pFilter != null ) ? pFilter.getSQLFilter( ) : null;

        if ( strFilter != null )
        {
            strSQl.append( "AND" );
            strSQl.append( strFilter );
        }

        strSQl.append( pOrder.getSQLOrderBy( ) );

        ReferenceList list = new ReferenceList( );
        try ( DAOUtil daoUtil = new DAOUtil( strSQl.toString( ) ) )
        {

            daoUtil.setInt( 1, nDocumentId );

            if ( strFilter != null )
            {
                if ( pFilter.getPortletFilterType( ).equals( PortletFilter.PAGE_NAME ) )
                {
                    for ( int i = 0; i < pFilter.getPageName( ).length; i++ )
                    {
                        daoUtil.setString( i + 2, "%" + pFilter.getPageName( ) [i] + "%" );
                    }
                }
                else
                    if ( pFilter.getPortletFilterType( ).equals( PortletFilter.PORTLET_NAME ) )
                    {
                        for ( int i = 0; i < pFilter.getPortletName( ).length; i++ )
                        {
                            daoUtil.setString( i + 2, "%" + pFilter.getPortletName( ) [i] + "%" );
                        }
                    }
                    else
                        if ( pFilter.getPortletFilterType( ).equals( PortletFilter.PAGE_ID ) )
                        {
                            daoUtil.setInt( 2, pFilter.getIdPage( ) );
                        }
            }

            daoUtil.executeQuery( );

            while ( daoUtil.next( ) )
            {
                list.addItem( daoUtil.getInt( 1 ), daoUtil.getString( 2 ) );
            }
        }

        return list;
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public int selectMinDocumentBlogOrder( )
    {
        int nKey = 1;
        try ( DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_MIN_DOC_ORDER ) )
        {
            daoUtil.executeQuery( );

            if ( daoUtil.next( ) )
            {
                nKey = daoUtil.getInt( 1 );
            }
        }
        return nKey;
    }

}