/*
    * 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.portal.web.features;
  
  import fr.paris.lutece.portal.business.right.FeatureGroup;
  import fr.paris.lutece.portal.business.right.FeatureGroupHome;
  import fr.paris.lutece.portal.business.right.Right;
  import fr.paris.lutece.portal.business.right.RightHome;
  import fr.paris.lutece.portal.service.admin.AccessDeniedException;
  import fr.paris.lutece.portal.service.message.AdminMessage;
  import fr.paris.lutece.portal.service.message.AdminMessageService;
  import fr.paris.lutece.portal.service.security.SecurityTokenService;
  import fr.paris.lutece.portal.service.template.AppTemplateService;
  import fr.paris.lutece.portal.web.admin.AdminFeaturesPageJspBean;
  import fr.paris.lutece.portal.web.constants.Messages;
  import fr.paris.lutece.portal.web.dashboard.AdminDashboardJspBean;
  import fr.paris.lutece.util.ReferenceList;
  import fr.paris.lutece.util.html.HtmlTemplate;
  import fr.paris.lutece.util.url.UrlItem;
  
  import java.io.Serializable;
  
  import java.util.HashMap;
  import java.util.Map;
  
  import javax.servlet.http.HttpServletRequest;
  
  import org.apache.commons.collections.CollectionUtils;
  
  /**
   * FeaturesGroupJspBean
   */
  public class FeaturesGroupJspBean extends AdminFeaturesPageJspBean
  {
      public static final String RIGHT_FEATURES_MANAGEMENT = "CORE_FEATURES_MANAGEMENT";
      private static final long serialVersionUID = -8573499137269541850L;
      private static final String TEMPLATE_CREATE_GROUP = "admin/features/create_group.html";
      private static final String TEMPLATE_MODIFY_GROUP = "admin/features/modify_group.html";
      private static final String PARAMETER_GROUP_ID = "group_id";
      private static final String PARAMETER_GROUP_NAME = "group_name";
      private static final String PARAMETER_GROUP_DESCRIPTION = "group_description";
      private static final String PARAMETER_GROUP_ORDER = "group_order";
      private static final String PARAMETER_GROUP_ICON = "group_icon";
      private static final String PARAMETER_ORDER_ID = "order_id";
      private static final String PARAMETER_RIGHT_ID = "right_id";
      private static final String JSP_REMOVE_GROUPS = "jsp/admin/features/DoRemoveGroup.jsp";
      private static final String MESSAGE_CONFIRM_DELETE = "portal.features.message.confirmDeleteGroup";
      private static final String MESSAGE_RIGHT_ALREADY_ASSIGN = "portal.features.message.rightAlreadyAssign";
      private static final String MARK_ORDER_LIST = "order_list";
      private static final String MARK_FEATURE_GROUP = "feature_group";
      private static final String MARK_DEFAULT_ORDER = "order_default";
      private static final String REGEX_ID = "^[\\d]+$";
      private static final String ANCHOR_ADMIN_DASHBOARDS = "features_management";
  
      /**
       * Dispatch a feature to a given group
       * 
       * @param request
       *            The HTTP request
       * @return The next URL to redirect after processing
       * @throws AccessDeniedException
       *             if the security token is invalid
       */
      public String doDispatchFeature( HttpServletRequest request ) throws AccessDeniedException
      {
          if ( !SecurityTokenService.getInstance( ).validate( request, AdminDashboardJspBean.TEMPLATE_MANAGE_DASHBOARDS ) )
          {
              throw new AccessDeniedException( ERROR_INVALID_TOKEN );
         }
         String strRightId = request.getParameter( PARAMETER_RIGHT_ID );
         String strGroupName = request.getParameter( PARAMETER_GROUP_NAME );
         String strOrderId = request.getParameter( PARAMETER_ORDER_ID );
         Right right = RightHome.findByPrimaryKey( strRightId );
         UrlItem/url/UrlItem.html#UrlItem">UrlItem url = new UrlItem( getDashboardUrl( request ) );
 
         if ( ( strGroupName != null ) )
         {
             // Set the old group as anchor
             url.setAnchor( right.getFeatureGroup( ) );
             right.setFeatureGroup( strGroupName.equals( "" ) ? null : strGroupName );
         }
 
         if ( ( strOrderId != null ) && strOrderId.matches( REGEX_ID ) )
         {
             right.setOrder( Integer.parseInt( strOrderId ) );
         }
 
         RightHome.update( right );
 
         return url.getUrl( );
     }
 
     /**
      * Dispatch a feature group
      *
      * @param request
      *            The HTTP request
      * @return The next URL to redirect after processing
      * @throws AccessDeniedException
      *             if the security token is invalid
      */
     public String doDispatchFeatureGroup( HttpServletRequest request ) throws AccessDeniedException
     {
         if ( !SecurityTokenService.getInstance( ).validate( request, AdminDashboardJspBean.TEMPLATE_MANAGE_DASHBOARDS ) )
         {
             throw new AccessDeniedException( ERROR_INVALID_TOKEN );
         }
         String strGroupId = request.getParameter( PARAMETER_GROUP_ID );
         String strOrderId = request.getParameter( PARAMETER_ORDER_ID );
         FeatureGroup featureGroup = FeatureGroupHome.findByPrimaryKey( strGroupId );
         UrlItem/url/UrlItem.html#UrlItem">UrlItem url = new UrlItem( getDashboardUrl( request ) );
 
         if ( ( strOrderId != null ) && strOrderId.matches( REGEX_ID ) )
         {
             featureGroup.setOrder( Integer.parseInt( strOrderId ) );
         }
 
         FeatureGroupHome.update( featureGroup );
 
         return url.getUrl( );
     }
 
     /**
      * Reinitialize feature orders
      * 
      * @param request
      *            The {@link HttpServletRequest}
      * @return The next URL to redirect after processing
      * @throws AccessDeniedException
      *             if the security token is invalid
      */
     public String doReinitFeatures( HttpServletRequest request ) throws AccessDeniedException
     {
         if ( !SecurityTokenService.getInstance( ).validate( request, AdminDashboardJspBean.TEMPLATE_MANAGE_DASHBOARDS ) )
         {
             throw new AccessDeniedException( ERROR_INVALID_TOKEN );
         }
         String strGroupId = request.getParameter( PARAMETER_GROUP_ID );
         RightHome.reinitFeatureOrders( strGroupId );
 
         UrlItem/url/UrlItem.html#UrlItem">UrlItem url = new UrlItem( getDashboardUrl( request ) );
 
         if ( ( strGroupId != null ) )
         {
             url.setAnchor( strGroupId );
         }
 
         return url.getUrl( );
     }
 
     /**
      * Returns the Create Group page
      * 
      * @param request
      *            The HTTP request
      * @return The HTML page
      */
     public String getCreateGroup( HttpServletRequest request )
     {
         int nCount = FeatureGroupHome.getFeatureGroupsCount( ) + 1;
 
         Map<String, Serializable> model = new HashMap<>( );
         model.put( MARK_ORDER_LIST, getOrderRefList( ) );
         model.put( MARK_DEFAULT_ORDER, String.valueOf( nCount ) );
         model.put( SecurityTokenService.MARK_TOKEN, SecurityTokenService.getInstance( ).getToken( request, AdminDashboardJspBean.TEMPLATE_MANAGE_DASHBOARDS ) );
 
         HtmlTemplate t = AppTemplateService.getTemplate( TEMPLATE_CREATE_GROUP, getLocale( ), model );
 
         return getAdminPage( t.getHtml( ) );
     }
 
     /**
      * Returns the Modify Group page
      * 
      * @param request
      *            The HTTP request
      * @return The HTML page
      */
     public String getModifyGroup( HttpServletRequest request )
     {
         String strGroupId = request.getParameter( PARAMETER_GROUP_ID );
 
         FeatureGroup group = FeatureGroupHome.findByPrimaryKey( strGroupId );
 
         if ( group == null )
         {
             return getDashboardUrl( request );
         }
 
         Map<String, Object> model = new HashMap<>( );
         model.put( MARK_ORDER_LIST, getOrderRefList( ) );
         model.put( MARK_FEATURE_GROUP, group );
         model.put( SecurityTokenService.MARK_TOKEN, SecurityTokenService.getInstance( ).getToken( request, AdminDashboardJspBean.TEMPLATE_MANAGE_DASHBOARDS ) );
 
         HtmlTemplate t = AppTemplateService.getTemplate( TEMPLATE_MODIFY_GROUP, getLocale( ), model );
 
         return getAdminPage( t.getHtml( ) );
     }
 
     /**
      * Create the group
      * 
      * @param request
      *            The HTTP request
      * @return The next URL to redirect after processing
      * @throws AccessDeniedException
      *             if the security token is invalid
      */
     public String doCreateGroup( HttpServletRequest request ) throws AccessDeniedException
     {
         String strGroupId = request.getParameter( PARAMETER_GROUP_ID );
         String strGroupName = request.getParameter( PARAMETER_GROUP_NAME );
         String strGroupDescription = request.getParameter( PARAMETER_GROUP_DESCRIPTION );
         String strGroupOrder = request.getParameter( PARAMETER_GROUP_ORDER );
         String strGroupIcon = request.getParameter( PARAMETER_GROUP_ICON );
 
         // Mandatory fields
         if ( strGroupId.equals( "" ) || strGroupName.equals( "" ) || strGroupDescription.equals( "" ) )
         {
             return AdminMessageService.getMessageUrl( request, Messages.MANDATORY_FIELDS, AdminMessage.TYPE_STOP );
         }
         if ( !SecurityTokenService.getInstance( ).validate( request, AdminDashboardJspBean.TEMPLATE_MANAGE_DASHBOARDS ) )
         {
             throw new AccessDeniedException( ERROR_INVALID_TOKEN );
         }
 
         FeatureGroupness/right/FeatureGroup.html#FeatureGroup">FeatureGroup group = new FeatureGroup( );
         group.setId( strGroupId );
         group.setLabelKey( strGroupName );
         group.setDescriptionKey( strGroupDescription );
         group.setIcon( strGroupIcon );
 
         FeatureGroupHome.create( group );
         group.setOrder( Integer.parseInt( strGroupOrder ) );
         FeatureGroupHome.update( group );
 
         return getDashboardUrl( request );
     }
 
     /**
      * Modify the group
      * 
      * @param request
      *            The HTTP request
      * @return The next URL to redirect after processing
      * @throws AccessDeniedException
      *             is the security token is invalid
      */
     public String doModifyGroup( HttpServletRequest request ) throws AccessDeniedException
     {
         String strGroupId = request.getParameter( PARAMETER_GROUP_ID );
         String strGroupName = request.getParameter( PARAMETER_GROUP_NAME );
         String strGroupDescription = request.getParameter( PARAMETER_GROUP_DESCRIPTION );
         String strGroupOrder = request.getParameter( PARAMETER_GROUP_ORDER );
         String strGroupIcon = request.getParameter( PARAMETER_GROUP_ICON );
 
         // Mandatory fields
         if ( strGroupId.equals( "" ) || strGroupName.equals( "" ) || strGroupDescription.equals( "" ) )
         {
             return AdminMessageService.getMessageUrl( request, Messages.MANDATORY_FIELDS, AdminMessage.TYPE_STOP );
         }
         if ( !SecurityTokenService.getInstance( ).validate( request, AdminDashboardJspBean.TEMPLATE_MANAGE_DASHBOARDS ) )
         {
             throw new AccessDeniedException( ERROR_INVALID_TOKEN );
         }
 
         FeatureGroup group = FeatureGroupHome.findByPrimaryKey( strGroupId );
         group.setLabelKey( strGroupName );
         group.setDescriptionKey( strGroupDescription );
         group.setOrder( Integer.parseInt( strGroupOrder ) );
         group.setIcon( strGroupIcon );
 
         FeatureGroupHome.update( group );
 
         return getDashboardUrl( request );
 
     }
 
     /**
      * Generate an HTML combo of available group order
      * 
      * @return The reference list of orders
      */
     private ReferenceList getOrderRefList( )
     {
         int nGroupsCount = FeatureGroupHome.getFeatureGroupsCount( );
         ReferenceListt.html#ReferenceList">ReferenceList listOrders = new ReferenceList( );
 
         for ( int i = 0; i < nGroupsCount; i++ )
         {
             listOrders.addItem( i + 1, Integer.toString( i + 1 ) );
         }
 
         return listOrders;
     }
 
     /**
      * Returns the Remove page
      * 
      * @param request
      *            The HTTP request
      * @return The HTML page
      */
     public String getRemoveGroup( HttpServletRequest request )
     {
         String strGroupId = request.getParameter( PARAMETER_GROUP_ID );
 
         String strUrl = JSP_REMOVE_GROUPS;
         Map<String, Object> parameters = new HashMap<>( );
         parameters.put( PARAMETER_GROUP_ID, strGroupId );
         parameters.put( SecurityTokenService.PARAMETER_TOKEN,
                 SecurityTokenService.getInstance( ).getToken( request, AdminDashboardJspBean.TEMPLATE_MANAGE_DASHBOARDS ) );
         FeatureGroup group = FeatureGroupHome.findByPrimaryKey( strGroupId );
         group.setLocale( getUser( ).getLocale( ) );
 
         Object [ ] messageArgs = {
                 group.getLabel( )
         };
 
         return AdminMessageService.getMessageUrl( request, MESSAGE_CONFIRM_DELETE, messageArgs, null, strUrl, "", AdminMessage.TYPE_CONFIRMATION, parameters );
     }
 
     /**
      * Remove the group
      * 
      * @param request
      *            The HTTP request
      * @return The next URL to redirect after processing
      * @throws AccessDeniedException
      *             if the security token is invalid
      */
     public String doRemoveGroup( HttpServletRequest request ) throws AccessDeniedException
     {
         String strGroupId = request.getParameter( PARAMETER_GROUP_ID );
 
         if ( CollectionUtils.isNotEmpty( RightHome.getRightsList( strGroupId ) ) )
         {
             return AdminMessageService.getMessageUrl( request, MESSAGE_RIGHT_ALREADY_ASSIGN, AdminMessage.TYPE_STOP );
         }
         if ( !SecurityTokenService.getInstance( ).validate( request, AdminDashboardJspBean.TEMPLATE_MANAGE_DASHBOARDS ) )
         {
             throw new AccessDeniedException( ERROR_INVALID_TOKEN );
         }
 
         FeatureGroupHome.remove( strGroupId );
 
         return getDashboardUrl( request );
     }
 
     /**
      * Returns the dashboard URL
      * 
      * @param request
      *            The HTTP request
      * @return the dashboard URL
      */
     private String getDashboardUrl( HttpServletRequest request )
     {
         return getAdminDashboardsUrl( request, ANCHOR_ADMIN_DASHBOARDS );
     }
 
 }