ExternalFeaturesJspBean.java

  1. /*
  2.  * Copyright (c) 2002-2022, City of Paris
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  *  1. Redistributions of source code must retain the above copyright notice
  10.  *     and the following disclaimer.
  11.  *
  12.  *  2. Redistributions in binary form must reproduce the above copyright notice
  13.  *     and the following disclaimer in the documentation and/or other materials
  14.  *     provided with the distribution.
  15.  *
  16.  *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
  17.  *     contributors may be used to endorse or promote products derived from
  18.  *     this software without specific prior written permission.
  19.  *
  20.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21.  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23.  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
  24.  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25.  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26.  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27.  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28.  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29.  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30.  * POSSIBILITY OF SUCH DAMAGE.
  31.  *
  32.  * License 1.0
  33.  */
  34. package fr.paris.lutece.portal.web.features;

  35. import java.util.Collection;
  36. import java.util.HashMap;
  37. import java.util.Map;

  38. import javax.servlet.http.HttpServletRequest;

  39. import fr.paris.lutece.portal.business.right.FeatureGroup;
  40. import fr.paris.lutece.portal.business.right.FeatureGroupHome;
  41. import fr.paris.lutece.portal.business.right.Level;
  42. import fr.paris.lutece.portal.business.right.LevelHome;
  43. import fr.paris.lutece.portal.business.right.Right;
  44. import fr.paris.lutece.portal.business.right.RightHome;
  45. import fr.paris.lutece.portal.business.user.AdminUser;
  46. import fr.paris.lutece.portal.service.admin.AccessDeniedException;
  47. import fr.paris.lutece.portal.service.admin.AdminUserService;
  48. import fr.paris.lutece.portal.service.message.AdminMessage;
  49. import fr.paris.lutece.portal.service.message.AdminMessageService;
  50. import fr.paris.lutece.portal.service.security.SecurityTokenService;
  51. import fr.paris.lutece.portal.service.template.AppTemplateService;
  52. import fr.paris.lutece.portal.web.admin.AdminFeaturesPageJspBean;
  53. import fr.paris.lutece.util.ReferenceList;
  54. import fr.paris.lutece.util.html.HtmlTemplate;

  55. /**
  56.  *
  57.  * @author closea
  58.  */
  59. public class ExternalFeaturesJspBean extends AdminFeaturesPageJspBean
  60. {
  61.     private static final long serialVersionUID = -5179996626579180810L;
  62.     // Properties
  63.     private static final String PROPERTY_CREATE_EXTERNAL_FEATURE_PAGETITLE = "portal.features.create_external_feature.pageTitle";
  64.     private static final String PROPERTY_MODIFY_EXTERNAL_FEATURE_PAGETITLE = "portal.features.modify_external_feature.pageTitle";

  65.     // Templates
  66.     private static final String TEMPLATE_CREATE_EXTERNAL_FEATURE = "admin/features/create_external_feature.html";
  67.     private static final String TEMPLATE_MODIFY_EXTERNAL_FEATURE = "admin/features/modify_external_feature.html";

  68.     // Messages
  69.     private static final String MESSAGE_CONFIRM_DELETE = "portal.features.delete_external_feature.confirmDeleteExternalFeature";

  70.     // Parameters
  71.     private static final String PARAMETER_ID_FEATURE_GROUP = "feature_group_id";
  72.     private static final String PARAMETER_ID_EXTERNAL_FEATURE = "external_feature_id";
  73.     private static final String PARAMETER_ID_LEVEL = "level_id";

  74.     // JSP
  75.     private static final String JSP_DELETE_EXTERNAL_FEATURE = "jsp/admin/features/DoRemoveExternalFeature.jsp";

  76.     // Rights
  77.     public static final String RIGHT_EXTERNAL_FEATURES_MANAGEMENT = "CORE_FEATURES_MANAGEMENT";

  78.     // Markers
  79.     private static final String MARK_EXTERNAL_FEATURE = "external_feature";
  80.     private static final String MARK_FEATURES_GROUPS_REFERENCE_LIST = "features_groups_labels_list";
  81.     private static final String MARK_RIGHT_LEVELS_REFERENCE_LIST = "right_levels_labels_list";

  82.     private static final String ANCHOR_ADMIN_DASHBOARDS = "external_features";

  83.     private Right _externalFeature;

  84.     public String getCreateExternalFeature( HttpServletRequest request )
  85.     {
  86.         setPageTitleProperty( PROPERTY_CREATE_EXTERNAL_FEATURE_PAGETITLE );

  87.         Map<String, Object> model = new HashMap<>( );

  88.         Collection<FeatureGroup> featureGroups = FeatureGroupHome.getFeatureGroupsList( );
  89.         ReferenceList featureGroupsReferenceList = new ReferenceList( );
  90.         for ( FeatureGroup featureGroup : featureGroups )
  91.         {
  92.             featureGroup.setLocale( getUser( ).getLocale( ) );
  93.             featureGroupsReferenceList.add( featureGroup.getReferenceItem( ) );
  94.         }
  95.         model.put( MARK_FEATURES_GROUPS_REFERENCE_LIST, featureGroupsReferenceList );

  96.         Collection<Level> rightLevels = LevelHome.getLevelsList( );
  97.         ReferenceList rightLevelsReferenceList = new ReferenceList( );
  98.         for ( Level rightLevel : rightLevels )
  99.         {
  100.             rightLevelsReferenceList.add( rightLevel.getReferenceItem( ) );
  101.         }
  102.         model.put( MARK_RIGHT_LEVELS_REFERENCE_LIST, rightLevelsReferenceList );
  103.         model.put( SecurityTokenService.MARK_TOKEN, SecurityTokenService.getInstance( ).getToken( request, TEMPLATE_CREATE_EXTERNAL_FEATURE ) );

  104.         HtmlTemplate template = AppTemplateService.getTemplate( TEMPLATE_CREATE_EXTERNAL_FEATURE, getLocale( ), model );

  105.         return getAdminPage( template.getHtml( ) );
  106.     }

  107.     public String doCreateExternalFeature( HttpServletRequest request ) throws AccessDeniedException
  108.     {
  109.         if ( !SecurityTokenService.getInstance( ).validate( request, TEMPLATE_CREATE_EXTERNAL_FEATURE ) )
  110.         {
  111.             throw new AccessDeniedException( ERROR_INVALID_TOKEN );
  112.         }
  113.         _externalFeature = new Right( );
  114.         populate( _externalFeature, request );
  115.         _externalFeature.setFeatureGroup( FeatureGroupHome.findByPrimaryKey( request.getParameter( PARAMETER_ID_FEATURE_GROUP ) ).getId( ) );
  116.         _externalFeature.setExternalFeature( true );
  117.         _externalFeature.setLevel( Integer.parseInt( request.getParameter( PARAMETER_ID_LEVEL ) ) );

  118.         RightHome.create( _externalFeature );
  119.         return getAdminDashboardsUrl( request, ANCHOR_ADMIN_DASHBOARDS );
  120.     }

  121.     public String getRemoveExternalFeature( HttpServletRequest request )
  122.     {

  123.         String strExternalFeatureId = request.getParameter( PARAMETER_ID_EXTERNAL_FEATURE );

  124.         _externalFeature = RightHome.findByPrimaryKey( strExternalFeatureId );
  125.         _externalFeature.setLocale( getUser( ).getLocale( ) );

  126.         Object [ ] messageArgs = {
  127.                 _externalFeature.getName( )
  128.         };

  129.         Map<String, Object> parameters = new HashMap<>( );
  130.         parameters.put( PARAMETER_ID_EXTERNAL_FEATURE, strExternalFeatureId );
  131.         parameters.put( SecurityTokenService.PARAMETER_TOKEN, SecurityTokenService.getInstance( ).getToken( request, JSP_DELETE_EXTERNAL_FEATURE ) );

  132.         return AdminMessageService.getMessageUrl( request, MESSAGE_CONFIRM_DELETE, messageArgs, null, JSP_DELETE_EXTERNAL_FEATURE, "",
  133.                 AdminMessage.TYPE_CONFIRMATION, parameters );
  134.     }

  135.     public String doRemoveExternalFeature( HttpServletRequest request ) throws AccessDeniedException
  136.     {
  137.         if ( !SecurityTokenService.getInstance( ).validate( request, JSP_DELETE_EXTERNAL_FEATURE ) )
  138.         {
  139.             throw new AccessDeniedException( ERROR_INVALID_TOKEN );
  140.         }
  141.         RightHome.remove( _externalFeature.getId( ) );

  142.         return getAdminDashboardsUrl( request, ANCHOR_ADMIN_DASHBOARDS );
  143.     }

  144.     public String getModifyExternalFeature( HttpServletRequest request )
  145.     {

  146.         setPageTitleProperty( PROPERTY_MODIFY_EXTERNAL_FEATURE_PAGETITLE );
  147.         Map<String, Object> model = new HashMap<>( );

  148.         String strExternalFeatureId = request.getParameter( PARAMETER_ID_EXTERNAL_FEATURE );
  149.         _externalFeature = RightHome.findByPrimaryKey( strExternalFeatureId );
  150.         model.put( MARK_EXTERNAL_FEATURE, _externalFeature );

  151.         Collection<FeatureGroup> featureGroups = FeatureGroupHome.getFeatureGroupsList( );
  152.         ReferenceList featureGroupsReferenceList = new ReferenceList( );
  153.         for ( FeatureGroup featureGroup : featureGroups )
  154.         {
  155.             featureGroup.setLocale( getUser( ).getLocale( ) );
  156.             featureGroupsReferenceList.add( featureGroup.getReferenceItem( ) );
  157.         }
  158.         model.put( MARK_FEATURES_GROUPS_REFERENCE_LIST, featureGroupsReferenceList );

  159.         Collection<Level> rightLevels = LevelHome.getLevelsList( );
  160.         ReferenceList rightLevelsReferenceList = new ReferenceList( );
  161.         for ( Level rightLevel : rightLevels )
  162.         {
  163.             rightLevelsReferenceList.add( rightLevel.getReferenceItem( ) );
  164.         }
  165.         model.put( MARK_RIGHT_LEVELS_REFERENCE_LIST, rightLevelsReferenceList );
  166.         model.put( SecurityTokenService.MARK_TOKEN, SecurityTokenService.getInstance( ).getToken( request, TEMPLATE_MODIFY_EXTERNAL_FEATURE ) );

  167.         HtmlTemplate template = AppTemplateService.getTemplate( TEMPLATE_MODIFY_EXTERNAL_FEATURE, getLocale( ), model );

  168.         return getAdminPage( template.getHtml( ) );
  169.     }

  170.     public String doModifyExternalFeature( HttpServletRequest request ) throws AccessDeniedException
  171.     {
  172.         if ( !SecurityTokenService.getInstance( ).validate( request, TEMPLATE_MODIFY_EXTERNAL_FEATURE ) )
  173.         {
  174.             throw new AccessDeniedException( ERROR_INVALID_TOKEN );
  175.         }
  176.         int nIdOrder = _externalFeature.getOrder( );
  177.         String strIdExternalFeature = _externalFeature.getId( );

  178.         _externalFeature = new Right( );
  179.         populate( _externalFeature, request );

  180.         _externalFeature.setId( strIdExternalFeature );
  181.         _externalFeature.setFeatureGroup( FeatureGroupHome.findByPrimaryKey( request.getParameter( PARAMETER_ID_FEATURE_GROUP ) ).getId( ) );
  182.         _externalFeature.setExternalFeature( true );
  183.         _externalFeature.setOrder( nIdOrder );
  184.         _externalFeature.setLevel( Integer.parseInt( request.getParameter( PARAMETER_ID_LEVEL ) ) );

  185.         RightHome.update( _externalFeature );

  186.         // update this right for user if he or she already have it
  187.         AdminUser user = AdminUserService.getAdminUser( request );
  188.         if ( user.checkRight( _externalFeature.getId( ) ) )
  189.         {
  190.             user.updateRight( _externalFeature );
  191.         }

  192.         return getAdminDashboardsUrl( request, ANCHOR_ADMIN_DASHBOARDS );
  193.     }
  194. }