ProposalSubscriptionXPage.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.participatoryideation.web;

import java.util.List;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import fr.paris.lutece.plugins.participatoryideation.service.subscription.IdeationSubscriptionProviderService;
import fr.paris.lutece.plugins.subscribe.business.Subscription;
import fr.paris.lutece.plugins.subscribe.business.SubscriptionFilter;
import fr.paris.lutece.plugins.subscribe.service.SubscriptionService;
import fr.paris.lutece.portal.service.security.LuteceUser;
import fr.paris.lutece.portal.service.security.SecurityService;
import fr.paris.lutece.portal.service.security.UserNotSignedException;
import fr.paris.lutece.portal.util.mvc.commons.annotations.Action;
import fr.paris.lutece.portal.util.mvc.commons.annotations.View;
import fr.paris.lutece.portal.util.mvc.xpage.MVCApplication;
import fr.paris.lutece.portal.util.mvc.xpage.annotations.Controller;
import fr.paris.lutece.portal.web.xpages.XPage;
import fr.paris.lutece.util.ReferenceItem;
import fr.paris.lutece.util.ReferenceList;

/**
 * This class provides the user interface to view Proposal xpages
 */

@Controller( xpageName = "mySubscriptions", pageTitleI18nKey = "participatoryideation.xpage.mySubscriptions.pageTitle", pagePathI18nKey = "participatoryideation.xpage.mySubscriptions.pagePathLabel" )
public class ProposalSubscriptionXPage extends MVCApplication
{

    // Templates
    private static final String TEMPLATE_VIEW_MY_SUBSCRIPTIONS = "/skin/plugins/participatoryideation/view_my_subscriptions.html";

    // Parameters
    private static final String PARAMETER_SELECT_SUBSCRIPTIONS = "select_subscriptions";

    // Markers
    private static final String MARK_LIST_USER_SUBSCRIPTIONS = "list_user_subscriptions";
    private static final String MARK_REF_LIST_SUBSCRIPTIONS = "list_subscriptions";

    // Views
    private static final String VIEW_MY_SUBSCRIPTIONS = "viewMySubscriptions";
    // Actions
    private static final String SAVE_MY_SUBSCRIPTIONS = "saveMySubscriptions";
    // Messages
    private static final String MESSAGE_SAVE_SUBSCRIPTIONS_SUCCESS = "participatoryideation.message.saveSubscriptionsSuccess";

    /**
     * Returns the form to update info about a proposal
     *
     * @param request
     *            The Http request
     * @return The HTML form to update info
     */
    @View( value = VIEW_MY_SUBSCRIPTIONS, defaultView = true )
    public XPage getMySubscriptions( HttpServletRequest request ) throws UserNotSignedException
    {
        Map<String, Object> model = getModel( );

        LuteceUser user = SecurityService.getInstance( ).getRegisteredUser( request );

        if ( user == null )
        {

            throw new UserNotSignedException( );
        }

        SubscriptionService subscriptionService = SubscriptionService.getInstance( );
        SubscriptionFilter filter = new SubscriptionFilter( );
        filter.setIdSubscriber( user.getName( ) );
        List<Subscription> listUserSubscriptions = subscriptionService.findByFilter( filter );
        ReferenceList refListSubscriptions = IdeationSubscriptionProviderService.getService( ).getRefListIdeationSubscription( getLocale( request ) );

        model.put( MARK_LIST_USER_SUBSCRIPTIONS, listUserSubscriptions );
        model.put( MARK_REF_LIST_SUBSCRIPTIONS, refListSubscriptions );

        return getXPage( TEMPLATE_VIEW_MY_SUBSCRIPTIONS, request.getLocale( ), model );
    }

    /**
     * Process save my subscriptions
     * 
     * @param request
     *            The HTTP request
     * @return The view
     */
    @Action( value = SAVE_MY_SUBSCRIPTIONS )
    public XPage doSaveMySubscriptions( HttpServletRequest request ) throws UserNotSignedException
    {
        LuteceUser user = SecurityService.getInstance( ).getRegisteredUser( request );

        if ( user == null )
        {

            throw new UserNotSignedException( );
        }
        String [ ] selectedSubscriptions = request.getParameterValues( PARAMETER_SELECT_SUBSCRIPTIONS );

        ReferenceList refListSubscriptions = IdeationSubscriptionProviderService.getService( ).getRefListIdeationSubscription( getLocale( request ) );

        for ( ReferenceItem subscription : refListSubscriptions )
        {
            boolean bMustCreate = false;

            if ( selectedSubscriptions != null )
            {
                for ( int i = 0; i < selectedSubscriptions.length; i++ )
                {

                    if ( selectedSubscriptions [i].equals( subscription.getCode( ) ) )
                    {

                        bMustCreate = true;
                    }
                }
            }
            if ( bMustCreate )
            {
                IdeationSubscriptionProviderService.getService( ).createSubscription( user, subscription.getCode( ) );
            }
            else
            {
                IdeationSubscriptionProviderService.getService( ).removeSubscription( user, subscription.getCode( ) );
            }

        }

        addInfo( MESSAGE_SAVE_SUBSCRIPTIONS_SUCCESS, getLocale( request ) );

        return redirectView( request, VIEW_MY_SUBSCRIPTIONS );

    }

}