VoteDashboardJspBean.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.participatorybudget.web.vote;
import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import javax.servlet.http.HttpServletRequest;
import org.apache.commons.lang3.RandomUtils;
import fr.paris.lutece.plugins.document.business.Document;
import fr.paris.lutece.plugins.document.business.DocumentFilter;
import fr.paris.lutece.plugins.document.business.DocumentHome;
import fr.paris.lutece.plugins.participatorybudget.business.campaign.Campaign;
import fr.paris.lutece.plugins.participatorybudget.business.campaign.CampaignHome;
import fr.paris.lutece.plugins.participatorybudget.business.campaign.CampaignPhase;
import fr.paris.lutece.plugins.participatorybudget.business.campaign.CampaignPhaseHome;
import fr.paris.lutece.plugins.participatorybudget.business.vote.Vote;
import fr.paris.lutece.plugins.participatorybudget.business.vote.VoteHome;
import fr.paris.lutece.plugins.participatorybudget.service.vote.VoteStatService;
import fr.paris.lutece.portal.service.i18n.I18nService;
import fr.paris.lutece.portal.service.message.AdminMessage;
import fr.paris.lutece.portal.service.message.AdminMessageService;
import fr.paris.lutece.portal.service.security.UserNotSignedException;
import fr.paris.lutece.portal.service.util.AppPropertiesService;
import fr.paris.lutece.portal.util.mvc.admin.MVCAdminJspBean;
import fr.paris.lutece.portal.util.mvc.admin.annotations.Controller;
import fr.paris.lutece.portal.util.mvc.commons.annotations.Action;
import fr.paris.lutece.portal.util.mvc.commons.annotations.View;
import fr.paris.lutece.util.ReferenceList;
import fr.paris.lutece.util.url.UrlItem;
/**
* This class provides the user interface to produce various business statistics
*/
@Controller( controllerJsp = "VoteDashboard.jsp", controllerPath = "jsp/admin/plugins/participatorybudget/vote/", right = "VOTE_DASHBOARD" )
public class VoteDashboardJspBean extends MVCAdminJspBean
{
private static final long serialVersionUID = 1L;
private Campaign campaign = CampaignHome.getLastCampaign( );
// RIGHTS
public static final String RIGHT_MANAGE_VOTE = "VOTE_DASHBOARD";
// TEMPLATES
private static final String TEMPLATE_MANAGE_VOTE_DASHBOARD = "admin/plugins/participatorybudget/vote/vote_dashboard.html";
// PROPERTIES
private static final String PROPERTY_PAGE_TITLE_VOTE_DASHBOARD = "participatorybudget.voteDashboard.pageTitle";
// PARAMETERS
private static final String PARAMETER_CAMPAIGN_ID = "campaign_id";
// MARKERS
private static final String MARK_PAGE_TITLE = "pageTitle";
private static final String MARK_CAMPAIGN_ID = "campaignId";
private static final String MARK_CAMPAIGN_CODE_LIST = "campaignCodeList";
private static final String MARK_NB_VOTES_BY_CAMPAIGN_CODE_MAP = "nbVotesByCampaignCodeMap";
private static final String MARK_NB_VOTES_BY_THEME_MAP = "nbVotesByThemeMap";
private static final String MARK_NB_VOTES_BY_LOCATION_MAP = "nbVotesByLocationMap";
private static final String MARK_NB_VOTES_BY_PROJECT_LIST = "nbVotesByProjectList";
private static final String MARK_NB_VOTES_BY_DATE_ALL_CAMPAIGNS_MAP = "nbVotesByDateAllCampaignsMap";
// VIEWS
private static final String VIEW_MANAGE_VOTE_DASHBOARD = "manageVoteDashboard";
// ACTIONS
private static final String ACTION_DO_CHANGE_CAMPAIGN = "changeCampaign";
private static final String ACTION_CONFIRM_GENERATE_RANDOM_VOTE_DATA = "confirmGenerateRandomVoteData";
private static final String ACTION_GENERATE_RANDOM_VOTE_DATA = "generateRandomVoteData";
// Messages
private static final String MESSAGE_CURRENT_CAMPAIGN_MODIFIED = "participatorybudget.vote_dashboard.message.currentCampaignModified";
private static final String MESSAGE_CONFIRM_GENERATE_RANDOM_VOTE_DATA = "participatorybudget.vote_dashboard.message.confirmGenerateRandomDataVote";
// *********************************************************************************************
// * VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW *
// * VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW VIEW *
// *********************************************************************************************
/**
* Displaying vote dashboard
*/
@View( value = VIEW_MANAGE_VOTE_DASHBOARD, defaultView = true )
public String getManageVoteDashboard( HttpServletRequest request ) throws UserNotSignedException
{
Map<String, Object> model = getModel( );
// Add global statistics
model.put( MARK_NB_VOTES_BY_CAMPAIGN_CODE_MAP, VoteStatService.getInstance( ).getNbVotesByCampaign( ) );
model.put( MARK_NB_VOTES_BY_DATE_ALL_CAMPAIGNS_MAP, VoteStatService.getInstance( ).getNbVotesByDateAllCampaigns( ) );
// Add statistics for current campaign
model.put( MARK_NB_VOTES_BY_THEME_MAP, VoteStatService.getInstance( ).getNbVotesByTheme( campaign.getId( ) ) );
model.put( MARK_NB_VOTES_BY_LOCATION_MAP, VoteStatService.getInstance( ).getNbVotesByLocation( campaign.getId( ) ) );
model.put( MARK_NB_VOTES_BY_PROJECT_LIST, VoteStatService.getInstance( ).getNbVotesByProject( campaign.getId( ) ) );
// Add list of campaigns
ReferenceList campaignList = new ReferenceList( );
for ( Campaign campaign : CampaignHome.getCampaignsList( ) )
{
campaignList.addItem( "" + campaign.getId( ), campaign.getCode( ) );
}
model.put( MARK_CAMPAIGN_CODE_LIST, campaignList );
// Add various data
model.put( MARK_PAGE_TITLE, AppPropertiesService.getProperty( PROPERTY_PAGE_TITLE_VOTE_DASHBOARD, "Vote Dashboard" ) );
model.put( MARK_CAMPAIGN_ID, campaign.getId( ) );
return getPage( PROPERTY_PAGE_TITLE_VOTE_DASHBOARD, TEMPLATE_MANAGE_VOTE_DASHBOARD, model );
}
// *********************************************************************************************
// * ACTION ACTION ACTION ACTION ACTION ACTION ACTION ACTION ACTION ACTION ACTION ACTION ACTIO *
// * ACTION ACTION ACTION ACTION ACTION ACTION ACTION ACTION ACTION ACTION ACTION ACTION ACTIO *
// *********************************************************************************************
/**
* Displaying vote dashboard
*/
@Action( value = ACTION_DO_CHANGE_CAMPAIGN )
public String doChangeCampaign( HttpServletRequest request ) throws UserNotSignedException
{
int campaignId = Integer.parseInt( request.getParameter( PARAMETER_CAMPAIGN_ID ) );
campaign = CampaignHome.findByPrimaryKey( campaignId );
addInfo( I18nService.getLocalizedString( MESSAGE_CURRENT_CAMPAIGN_MODIFIED, new String [ ] {
campaign.getCode( )
}, request.getLocale( ) ) );
return getManageVoteDashboard( request );
}
/**
* Confirmation of generation of randomize vote data
*/
@Action( ACTION_CONFIRM_GENERATE_RANDOM_VOTE_DATA )
public String getConfirmGenerateRandomVoteData( HttpServletRequest request )
{
UrlItem url = new UrlItem( getActionUrl( ACTION_GENERATE_RANDOM_VOTE_DATA ) );
String strMessageUrl = AdminMessageService.getMessageUrl( request, MESSAGE_CONFIRM_GENERATE_RANDOM_VOTE_DATA, url.getUrl( ),
AdminMessage.TYPE_CONFIRMATION );
return redirect( request, strMessageUrl );
}
/**
* Generation of randomize vote data
*/
@Action( ACTION_GENERATE_RANDOM_VOTE_DATA )
public String getGenerateRandomVoteData( HttpServletRequest request ) throws UserNotSignedException
{
DocumentFilter documentFilter = new DocumentFilter( );
documentFilter.setCodeDocumentType( "pb_project" );
List<Document> documents = new ArrayList<Document>( DocumentHome.findByFilter( documentFilter, request.getLocale( ) ) );
List<Campaign> campaigns = new ArrayList<Campaign>( CampaignHome.getCampaignsList( ) );
// Add 10 votes
for ( int i = 0; i < 10; i++ )
{
Vote vote = new Vote( );
// User id
vote.setUserId( UUID.randomUUID( ).toString( ) );
// Project data
Document document = documents.get( RandomUtils.nextInt( 0, documents.size( ) ) );
vote.setProjetId( document.getId( ) );
vote.setTitle( document.getTitle( ) );
vote.setLocation( "" + document.getAttribute( "location" ).getId( ) );
vote.setTheme( document.getAttribute( "theme" ).getTextValue( ) );
// Vote date
Campaign campaign = campaigns.get( RandomUtils.nextInt( 0, campaigns.size( ) ) );
Collection<CampaignPhase> phases = CampaignPhaseHome.getCampaignPhasesListByCampaign( campaign.getCode( ) );
CampaignPhase votePhase = phases.stream( ).filter( p -> "VOTE".contentEquals( p.getCodePhaseType( ) ) ).findFirst( ).get( );
int voteNbDays = Math.round( ( votePhase.getEnd( ).getTime( ) - votePhase.getStart( ).getTime( ) ) / ( 1000 * 60 * 60 * 24 ) );
Calendar cal = Calendar.getInstance( );
cal.setTime( votePhase.getStart( ) );
cal.add( Calendar.DAY_OF_WEEK, RandomUtils.nextInt( 0, voteNbDays ) );
vote.setDateVote( new Timestamp( cal.getTime( ).getTime( ) ) );
// Empty fields
vote.setIpAddress( "127.0.0.1" );
VoteHome.create( vote );
}
return getManageVoteDashboard( request );
}
}