Form.java
/*
* 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.plugins.forms.business;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.Size;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.math.NumberUtils;
import fr.paris.lutece.portal.business.file.File;
import fr.paris.lutece.portal.service.rbac.RBACResource;
import fr.paris.lutece.portal.service.workgroup.AdminWorkgroupResource;
import java.sql.Date;
import java.sql.Timestamp;
import java.util.Base64;
import java.util.Comparator;
import java.util.List;
/**
* This is the business class for the object Form
*/
public class Form implements AdminWorkgroupResource, RBACResource, Comparator<Form>
{
/**
* Form resource type
*/
public static final String RESOURCE_TYPE = "FORMS_FORM";
/**
* State of forms that are enabled
*/
public static final int STATE_ENABLE = 1;
/**
* State of forms that are disabled
*/
public static final int STATE_DISABLE = 0;
// Variables declarations
private int _nId;
@NotEmpty( message = "#i18n{forms.validation.form.Title.notEmpty}" )
@Size( max = 255, message = "#i18n{forms.validation.form.Title.size}" )
private String _strTitle;
@Size( max = 255, message = "#i18n{forms.validation.form.Description.size}" )
private String _strDescription;
private Timestamp _dateCreation;
private Timestamp _dateAvailabilityStartDate;
private Timestamp _dateAvailabilityEndDate;
private Timestamp _dateUpdate;
private String _strWorkgroup;
private List<FormAction> _listActions;
private int _nIdWorkflow;
private boolean _bAuthentificationNeeded;
@NotEmpty( message = "#i18n{forms.validation.form.Breadcrumb.notEmpty}" )
@Size( max = 255, message = "#i18n{forms.validation.form.Breadcrumb.size}" )
private String _strBreadcrumbName;
@Size( max = 255, message = "#i18n{forms.validation.form.ReturnUrl.size}" )
private String _strReturnUrl;
private boolean _bDisplaySummary;
private int _nMaxNumberResponse;
private boolean _bOneResponseByUser;
private int _nCurrentNumberResponse;
private boolean _bCaptchaStepInitial;
private boolean _bCaptchaStepFinal;
private boolean _bCaptchaRecap;
private boolean _bCountResponses;
private String _labelFinalButton;
private String _strUnavailableMessage;
private File _logo;
private int _nIdCategory;
private boolean _bBackupEnabled;
/**
* Access to responses management on FO by role
**/
private boolean _bAccessToResponsesByRole;
/**
* Default constructor
*/
public Form( )
{
super( );
}
/**
* Copy constructor
*
* Leaves out dynamic data
*
* @param source
* source Form to copy
*/
Form( Form source )
{
_bAccessToResponsesByRole = source._bAccessToResponsesByRole;
_bAuthentificationNeeded = source._bAuthentificationNeeded;
_bBackupEnabled = source._bBackupEnabled;
_bCaptchaRecap = source._bCaptchaRecap;
_bCaptchaStepFinal = source._bCaptchaStepFinal;
_bCaptchaStepInitial = source._bCaptchaStepInitial;
_bCountResponses = source._bCountResponses;
_bDisplaySummary = source._bDisplaySummary;
_bOneResponseByUser = source._bOneResponseByUser;
_dateAvailabilityEndDate = source._dateAvailabilityEndDate;
_dateAvailabilityStartDate = source._dateAvailabilityStartDate;
_dateCreation = source._dateCreation;
_dateUpdate = source._dateUpdate;
_labelFinalButton = source._labelFinalButton;
// _listActions = null;
_logo = source._logo;
// _nCurrentNumberResponse = 0;
_nId = source._nId;
_nIdCategory = source._nIdCategory;
_nIdWorkflow = source._nIdWorkflow;
_nMaxNumberResponse = source._nMaxNumberResponse;
_strBreadcrumbName = source._strBreadcrumbName;
_strDescription = source._strDescription;
_strReturnUrl = source._strReturnUrl;
_strTitle = source._strTitle;
_strUnavailableMessage = source._strUnavailableMessage;
_strWorkgroup = source._strWorkgroup;
}
/**
* Returns the Id
*
* @return The Id
*/
public int getId( )
{
return _nId;
}
/**
* Sets the Id
*
* @param nId
* The Id
*/
public void setId( int nId )
{
_nId = nId;
}
/**
* Returns the Title
*
* @return The Title
*/
public String getTitle( )
{
return _strTitle;
}
/**
* Sets the Title
*
* @param strTitle
* The Title
*/
public void setTitle( String strTitle )
{
_strTitle = strTitle;
}
/**
* Returns the Description
*
* @return The Description
*/
public String getDescription( )
{
return _strDescription;
}
/**
* Sets the Description
*
* @param strDescription
* The Description
*/
public void setDescription( String strDescription )
{
_strDescription = strDescription;
}
/**
* Returns the CreationDate
*
* @return The CreationDate
*/
public Timestamp getCreationDate( )
{
return _dateCreation;
}
/**
* Sets the CreationDate
*
* @param creationDate
* The CreationDate
*/
public void setCreationDate( Timestamp creationDate )
{
_dateCreation = creationDate;
}
/**
* Returns the UpdateDate
*
* @return The UpdateDate
*/
public Timestamp getUpdateDate( )
{
return _dateUpdate;
}
/**
* Sets the UpdateDate
*
* @param dateUpdate
* The UpdateDate
*/
public void setUpdateDate( Timestamp dateUpdate )
{
_dateUpdate = dateUpdate;
}
/**
* Returns the AvailabilityStartDate
*
* @return The AvailabilityStartDate
*/
public Timestamp getAvailabilityStartDate( )
{
return _dateAvailabilityStartDate;
}
/**
* Sets the AvailabilityStartDate
*
* @param dateAvailabilityStartDate
* The AvailabilityStartDate
*/
public void setAvailabilityStartDate( Timestamp dateAvailabilityStartDate )
{
_dateAvailabilityStartDate = dateAvailabilityStartDate;
}
/**
* Returns the AvailabilityEndDate
*
* @return The AvailabilityEndDate
*/
public Timestamp getAvailabilityEndDate( )
{
return _dateAvailabilityEndDate;
}
/**
* Sets the AvailabilityEndDate
*
* @param dateAvailabilityEndDate
* The AvailabilityEndDate
*/
public void setAvailabilityEndDate( Timestamp dateAvailabilityEndDate )
{
_dateAvailabilityEndDate = dateAvailabilityEndDate;
}
/**
* {@inheritDoc}
*/
@Override
public String getResourceTypeCode( )
{
return RESOURCE_TYPE;
}
/**
* {@inheritDoc}
*/
@Override
public String getResourceId( )
{
return StringUtils.EMPTY + _nId;
}
/**
* {@inheritDoc}
*/
@Override
public String getWorkgroup( )
{
return _strWorkgroup;
}
/**
* set the work group associate to the form
*
* @param workGroup
* the work group associate to the form
*/
public void setWorkgroup( String workGroup )
{
_strWorkgroup = workGroup;
}
/**
*
* @return a list of action can be use for the form
*/
public List<FormAction> getActions( )
{
return _listActions;
}
/**
* set a list of action can be use for the form
*
* @param formActions
* a list of action must be use for the form
*/
public void setActions( List<FormAction> formActions )
{
_listActions = formActions;
}
/**
* Returns the active status of a form by checking if we are currently within its availability period
*
* @return true if the form is active
*/
public boolean isActive( )
{
boolean bActive = false;
Date dToday = new Date( System.currentTimeMillis( ) );
if ( _dateAvailabilityStartDate != null && _dateAvailabilityStartDate.before( dToday )
&& ( _dateAvailabilityEndDate == null || _dateAvailabilityEndDate.after( dToday ) ) )
{
bActive = true;
}
if ( _dateAvailabilityStartDate == null && ( _dateAvailabilityEndDate != null && _dateAvailabilityEndDate.after( dToday ) ) )
{
bActive = true;
}
return bActive;
}
/**
* Getter for id_workflow
*
* @return the _nIdWorkflow
*/
public int getIdWorkflow( )
{
return _nIdWorkflow;
}
/**
* setter for id_workflow
*
* @param nIdWorkflow
* the Id Workflow to set
*/
public void setIdWorkflow( int nIdWorkflow )
{
_nIdWorkflow = nIdWorkflow;
}
/**
* @return the _bAuthentificationNeeded
*/
public boolean isAuthentificationNeeded( )
{
return _bAuthentificationNeeded;
}
/**
* @param bAuthentificationNeeded
* the bAuthentificationNeeded to set
*/
public void setAuthentificationNeeded( boolean bAuthentificationNeeded )
{
this._bAuthentificationNeeded = bAuthentificationNeeded;
}
/**
* Returns the BreadcrumbName
*
* @return The BreadcrumbName
*/
public String getBreadcrumbName( )
{
return _strBreadcrumbName;
}
/**
* Sets the Title
*
* @param strBreadcrumbName
* The breadcrumb bean name
*/
public void setBreadcrumbName( String strBreadcrumbName )
{
_strBreadcrumbName = strBreadcrumbName;
}
/**
* Returns the return URL
*
* @return The return URL
*/
public String getReturnUrl( )
{
return _strReturnUrl;
}
/**
* Sets the return URL
*
* @param strReturnUrl
* The form return page URL
*/
public void setReturnUrl( String strReturnUrl )
{
_strReturnUrl = strReturnUrl;
}
/**
* Tells if the summary must be displayed
*
* @return {@code true} if the summary must be displayed, {@code false} otherwise
*/
public boolean isDisplaySummary( )
{
return _bDisplaySummary;
}
/**
* Sets if the summary must be displayed
*
* @param bDisplaySummary
* {@code true} if the summary must be displayed, {@code false} otherwise
*/
public void setDisplaySummary( boolean bDisplaySummary )
{
_bDisplaySummary = bDisplaySummary;
}
/**
* Returns the number Max of response form
*
* @return The number max of reponse for
*/
public int getMaxNumberResponse( )
{
return _nMaxNumberResponse;
}
/**
* Sets the number Max of response form
*
* @param nMaxNumberResponse
* The number max of reponse form
*/
public void setMaxNumberResponse( int nMaxNumberResponse )
{
_nMaxNumberResponse = nMaxNumberResponse;
}
/**
* Check the user can only submit one form.
*
* @return true if the user can submit just one form
*/
public boolean isOneResponseByUser( )
{
return _bOneResponseByUser;
}
/**
* set true if the user can submit just once the form
*
* @param bOneResponseByUser
* true if the user can submit just one form
*/
public void setOneResponseByUser( boolean bOneResponseByUser )
{
_bOneResponseByUser = bOneResponseByUser;
}
/**
* @return the nCurrentNumberResponse
*/
public int getCurrentNumberResponse( )
{
return _nCurrentNumberResponse;
}
/**
* @param nCurrentNumberResponse
* the nCurrentNumberResponse to set
*/
public void setCurrentNumberResponse( int nCurrentNumberResponse )
{
_nCurrentNumberResponse = nCurrentNumberResponse;
}
/**
* @return the bCaptchaStepInitial
*/
public boolean isCaptchaStepInitial( )
{
return _bCaptchaStepInitial;
}
/**
* @param bCaptchaStepInitial
* the bCaptchaStepInitial to set
*/
public void setCaptchaStepInitial( boolean bCaptchaStepInitial )
{
_bCaptchaStepInitial = bCaptchaStepInitial;
}
/**
* @return the bCaptchaStepFinal
*/
public boolean isCaptchaStepFinal( )
{
return _bCaptchaStepFinal;
}
/**
* @param bCaptchaStepFinal
* the bCaptchaStepFinel to set
*/
public void setCaptchaStepFinal( boolean bCaptchaStepFinal )
{
_bCaptchaStepFinal = bCaptchaStepFinal;
}
/**
* @return the bCaptchaRecap
*/
public boolean isCaptchaRecap( )
{
return _bCaptchaRecap;
}
/**
* @param bCaptchaRecap
* the bCaptchaRecap to set
*/
public void setCaptchaRecap( boolean bCaptchaRecap )
{
_bCaptchaRecap = bCaptchaRecap;
}
/**
* @return the bCountResponse
*/
public boolean isCountResponses( )
{
return _bCountResponses;
}
/**
* @param bCountResponse
* the bCountResponse to set
*/
public void setCountResponses( boolean bCountResponse )
{
_bCountResponses = bCountResponse;
}
/**
* @return the labelFinalButton
*/
public String getLabelFinalButton( )
{
return _labelFinalButton;
}
/**
* @param labelFinalButton
* the labelFinalButton to set
*/
public void setLabelFinalButton( String labelFinalButton )
{
_labelFinalButton = labelFinalButton;
}
/**
* @return the strUnavailableMessage
*/
public String getUnavailableMessage( )
{
return _strUnavailableMessage;
}
/**
* @param strUnavailableMessage
* the strUnavailableMessage to set
*/
public void setUnavailableMessage( String strUnavailableMessage )
{
_strUnavailableMessage = strUnavailableMessage;
}
/**
* @return the logo
*/
public File getLogo( )
{
return _logo;
}
/**
* @param logo
* the logo to set
*/
public void setLogo( File logo )
{
_logo = logo;
}
/**
* Get the content of the logo as base64
*
* @return
*/
public String getLogoBase64( )
{
if ( _logo == null || _logo.getPhysicalFile( ) == null )
{
return null;
}
return Base64.getEncoder( ).encodeToString( _logo.getPhysicalFile( ).getValue( ) );
}
/**
* @return the id of the category linked to the form
*/
public int getIdCategory( )
{
return _nIdCategory;
}
/**
* @param _nIdCategory
* the _nIdCategory to set
*/
public void setIdCategory( int nIdCategory )
{
this._nIdCategory = nIdCategory;
}
/**
* @return the bBackupEnabled
*/
public boolean isBackupEnabled( )
{
return _bBackupEnabled;
}
/**
* @param bBackupEnabled the bBackupEnabled to set
*/
public void setBackupEnabled( boolean bBackupEnabled )
{
_bBackupEnabled = bBackupEnabled;
}
/**
* @return the id of the category linked to the form
*/
public FormCategory getCategory( )
{
return FormCategoryHome.findByPrimaryKey( _nIdCategory );
}
/**
* Returns true if the access to responses management on FO is based on the roles, false otherwise
* @return true if the access to responses management on FO is based on the roles, false otherwise
*/
public boolean isAccessToResponsesByRole()
{
return _bAccessToResponsesByRole;
}
/**
* Sets the AccessToResponsesByRole
* @param bAccessToResponsesByRole The AccessToResponsesByRole
*/
public void setAccessToResponsesByRole( boolean bAccessToResponsesByRole )
{
_bAccessToResponsesByRole = bAccessToResponsesByRole;
}
/**
* Custom comparator for Availability Period sorting
*/
@Override
public int compare(Form form1, Form form2) {
int nComparisonResult = NumberUtils.INTEGER_ZERO;
if (form1 == null) {
if (form2 != null) {
nComparisonResult = NumberUtils.INTEGER_MINUS_ONE;
}
} else {
if (form2 == null) {
nComparisonResult = NumberUtils.INTEGER_ONE;
} else {
nComparisonResult = compareFormsAviability(form1, form2);
}
}
return nComparisonResult;
}
private int compareFormsAviability(Form form1, Form form2) {
int nComparisonResult = NumberUtils.INTEGER_ZERO;
if (form1.isActive()) {
if (!form2.isActive()) {
nComparisonResult = NumberUtils.INTEGER_ONE;
}
} else {
if (form2.isActive()) {
nComparisonResult = NumberUtils.INTEGER_MINUS_ONE;
} else {
boolean bIsSoonToBeActivatedForm1 = isSoonToBeActivated(form1);
boolean bIsSoonToBeActivatedForm2 = isSoonToBeActivated(form2);
if (bIsSoonToBeActivatedForm1 && !bIsSoonToBeActivatedForm2) {
nComparisonResult = NumberUtils.INTEGER_ONE;
} else if (!bIsSoonToBeActivatedForm1 && bIsSoonToBeActivatedForm2) {
nComparisonResult = NumberUtils.INTEGER_MINUS_ONE;
}
}
}
return nComparisonResult;
}
/**
* Returns the soon to be activated status of a form
* @param form
* @return true if the form is soon to be activated, false otherwise
*/
private boolean isSoonToBeActivated(Form form) {
Date dToday = new Date(System.currentTimeMillis());
if (form != null && form.getAvailabilityStartDate() != null && form.getAvailabilityStartDate().after(dToday) ) {
return true;
}
return false;
}
}