FormsListPortletJspBean.java
/*
* Copyright (c) 2002-2025, 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.forms.web.portlet;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.stream.Collectors;
import javax.servlet.http.HttpServletRequest;
import org.apache.commons.collections4.CollectionUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.math.NumberUtils;
import fr.paris.lutece.api.user.User;
import fr.paris.lutece.plugins.forms.business.Form;
import fr.paris.lutece.plugins.forms.business.FormHome;
import fr.paris.lutece.plugins.forms.business.portlet.FormsListPortlet;
import fr.paris.lutece.plugins.forms.business.portlet.FormsListPortletHome;
import fr.paris.lutece.portal.business.portlet.PortletHome;
import fr.paris.lutece.portal.service.workgroup.AdminWorkgroupService;
import fr.paris.lutece.portal.web.portlet.PortletJspBean;
import fr.paris.lutece.util.html.HtmlTemplate;
import fr.paris.lutece.util.json.JsonResponse;
import fr.paris.lutece.util.json.JsonUtil;
/**
* This class provides the user interface to manage FormsList Portlet
*/
public class FormsListPortletJspBean extends PortletJspBean
{
private static final long serialVersionUID = 4077345110036566513L;
// Parameters
private static final String PARAMETER_ACTION_PORTLET = "action";
private static final String PARAMETER_ACTION_PORTLET_ADD = "add";
private static final String PARAMETER_ACTION_PORTLET_REMOVE = "remove";
private static final String PARAMETER_FROM_ID = "form_id";
// Marks
private static final String MARK_AVAILABLE_FORMS_LIST = "available_forms_list";
private static final String MARK_PUBLISHED_FORMS_LIST = "published_forms_list";
// Constants
private static final String RESPONSE_SUCCESS = "SUCCESS";
// Variables
private FormsListPortlet _portlet;
/**
* Returns the FormsListPortlet form of creation
*
* @param request
* The Http rquest
* @return the html code of the FormsListPortlet portlet form
*/
@Override
public String getCreate( HttpServletRequest request )
{
HashMap<String, Object> model = new HashMap<>( );
String strPageId = request.getParameter( PARAMETER_PAGE_ID );
String strPortletTypeId = request.getParameter( PARAMETER_PORTLET_TYPE_ID );
if ( _portlet == null )
{
_portlet = new FormsListPortlet( );
}
model.put( MARK_AVAILABLE_FORMS_LIST, getActiveForms( ) );
model.put( MARK_PUBLISHED_FORMS_LIST, new ArrayList<>( ) );
HtmlTemplate template = getCreateTemplate( strPageId, strPortletTypeId, model );
return template.getHtml( );
}
/**
* Treats the creation form of a new FormsListPortlet portlet
*
* @param request
* The Http request
* @return The jsp URL which displays the view of the created FormsListPortlet portlet
*/
@Override
public String doCreate( HttpServletRequest request )
{
String strPageId = request.getParameter( PARAMETER_PAGE_ID );
int nPageId = NumberUtils.toInt( strPageId, NumberUtils.INTEGER_MINUS_ONE );
String strErrorUrl = setPortletCommonData( request, _portlet );
if ( strErrorUrl != null )
{
return strErrorUrl;
}
_portlet.setPageId( nPageId );
FormsListPortletHome.getInstance( ).create( _portlet );
return getPageUrl( nPageId );
}
/**
* Returns the FormsListPortlet form for update
*
* @param request
* The Http request
* @return the html code of the FormsListPortlet form
*/
@Override
public String getModify( HttpServletRequest request )
{
HashMap<String, Object> model = new HashMap<>( );
List<Form> availableFormsList = new ArrayList<>( );
List<Form> publishedFormsList = new ArrayList<>( );
String strPortletId = request.getParameter( PARAMETER_PORTLET_ID );
int nPortletId = NumberUtils.toInt( strPortletId, NumberUtils.INTEGER_MINUS_ONE );
_portlet = (FormsListPortlet) PortletHome.findByPrimaryKey( nPortletId );
if ( CollectionUtils.isNotEmpty( _portlet.getFormsIdList( ) ) )
{
publishedFormsList = FormHome.getFormByPrimaryKeyList( _portlet.getFormsIdList( ) );
availableFormsList = getActiveForms( );
availableFormsList.removeAll( publishedFormsList );
}
model.put( MARK_AVAILABLE_FORMS_LIST, availableFormsList );
model.put( MARK_PUBLISHED_FORMS_LIST, publishedFormsList );
HtmlTemplate template = getModifyTemplate( _portlet, model );
return template.getHtml( );
}
/**
* Treats the update form of the FormsListPortlet portlet whose identifier is in the http request
*
* @param request
* The Http request
* @return The jsp URL which displays the view of the updated portlet
*/
@Override
public String doModify( HttpServletRequest request )
{
String strErrorUrl = setPortletCommonData( request, _portlet );
if ( strErrorUrl != null )
{
return strErrorUrl;
}
_portlet.update( );
return getPageUrl( _portlet.getPageId( ) );
}
/**
* Update form portlet
*
* @param request
* The Http request
* @return Json
* The Json succes or echec
*/
public String updatePortletForm( HttpServletRequest request )
{
String strAction = request.getParameter( PARAMETER_ACTION_PORTLET );
String strFormId = request.getParameter( PARAMETER_FROM_ID );
if ( StringUtils.isNoneBlank( strAction ) && strAction.equals( PARAMETER_ACTION_PORTLET_ADD ) )
{
_portlet.addFormId( NumberUtils.toInt( strFormId ) );
}
else if ( StringUtils.isNoneBlank( strAction ) && strAction.equals( PARAMETER_ACTION_PORTLET_REMOVE ) )
{
_portlet.removeFormId( NumberUtils.toInt( strFormId ) );
}
return JsonUtil.buildJsonResponse( new JsonResponse( RESPONSE_SUCCESS ) );
}
/**
* get the active forms
*
* @return active forms
*/
private List<Form> getActiveForms( )
{
List<Form> formsList = FormHome.getFormList( );
formsList = (List<Form>) AdminWorkgroupService.getAuthorizedCollection( formsList, (User) getUser( ) );
if ( CollectionUtils.isNotEmpty(formsList) )
{
return formsList.stream( ).filter( Form::isActive ).collect( Collectors.toList( ) );
}
else
{
return new ArrayList<>( );
}
}
}