/*
    * 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.workflow.service;
  
  import fr.paris.lutece.plugins.workflow.utils.WorkflowUtils;
  import fr.paris.lutece.plugins.workflowcore.business.action.Action;
  import fr.paris.lutece.plugins.workflowcore.business.action.ActionFilter;
  import fr.paris.lutece.plugins.workflowcore.business.state.State;
  import fr.paris.lutece.plugins.workflowcore.service.action.ActionService;
  import fr.paris.lutece.plugins.workflowcore.service.action.IActionService;
  import fr.paris.lutece.plugins.workflowcore.service.state.IStateService;
  import fr.paris.lutece.plugins.workflowcore.service.state.StateService;
  import fr.paris.lutece.plugins.workflowcore.service.workflow.IWorkflowService;
  import fr.paris.lutece.plugins.workflowcore.service.workflow.WorkflowService;
  import fr.paris.lutece.portal.service.rbac.Permission;
  import fr.paris.lutece.portal.service.rbac.ResourceIdService;
  import fr.paris.lutece.portal.service.rbac.ResourceType;
  import fr.paris.lutece.portal.service.rbac.ResourceTypeManager;
  import fr.paris.lutece.portal.service.spring.SpringContextService;
  import fr.paris.lutece.util.ReferenceList;
  
  import java.util.List;
  import java.util.Locale;
  
  /**
   *
   * class ActionResourceIdService
   *
   */
  public class ActionResourceIdService extends ResourceIdService
  {
      /** Permission for viewing a action */
      public static final String PERMISSION_VIEW = "VIEW";
  
      /** Permission for managing advanced parameters */
      public static final String PERMISSION_MANAGE_ADVANCED_PARAMETERS = "MANAGE_ADVANCED_PARAMETERS";
      private static final String PROPERTY_LABEL_RESOURCE_TYPE = "workflow.permission.label.resource_type_action";
      private static final String PROPERTY_LABEL_VIEW = "workflow.permission.label.view_action";
      private static final String PROPERTY_LABEL_MANAGE_ADVANCED_PARAMETERS = "workflow.permission.label.manage_advanced_parameters";
  
      /** Creates a new instance of DocumentTypeResourceIdService */
      public ActionResourceIdService( )
      {
          setPluginName( WorkflowPlugin.PLUGIN_NAME );
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public void register( )
      {
          ResourceType rt = new ResourceType( );
          rt.setResourceIdServiceClass( ActionResourceIdService.class.getName( ) );
          rt.setPluginName( WorkflowPlugin.PLUGIN_NAME );
          rt.setResourceTypeKey( Action.RESOURCE_TYPE );
          rt.setResourceTypeLabelKey( PROPERTY_LABEL_RESOURCE_TYPE );
  
          Permission p = new Permission( );
          p.setPermissionKey( PERMISSION_VIEW );
          p.setPermissionTitleKey( PROPERTY_LABEL_VIEW );
          rt.registerPermission( p );
  
          p = new Permission( );
          p.setPermissionKey( PERMISSION_MANAGE_ADVANCED_PARAMETERS );
          p.setPermissionTitleKey( PROPERTY_LABEL_MANAGE_ADVANCED_PARAMETERS );
          rt.registerPermission( p );
  
         ResourceTypeManager.registerResourceType( rt );
     }
 
     /**
      * Returns a list of action resource ids
      * 
      * @param locale
      *            The current locale
      * @return A list of resource ids
      */
     public ReferenceList getResourceIdList( Locale locale )
     {
         IActionService actionService = SpringContextService.getBean( ActionService.BEAN_SERVICE );
         ActionFilter actionFilter = new ActionFilter( );
         actionFilter.setAutomaticReflexiveAction( false );
 
         List<Action> listAction = actionService.getListActionByFilter( actionFilter );
         ReferenceList reflistAction = new ReferenceList( );
 
         for ( Action action : listAction )
         {
             reflistAction.addItem( action.getId( ), getActionLabel( action ) );
         }
 
         return reflistAction;
     }
 
     /**
      * Returns the Title of a given resource
      * 
      * @param strId
      *            The Id of the resource
      * @param locale
      *            The current locale
      * @return The Title of a given resource
      */
     public String getTitle( String strId, Locale locale )
     {
         IActionService actionService = SpringContextService.getBean( ActionService.BEAN_SERVICE );
         int nId = WorkflowUtils.convertStringToInt( strId );
         Action action = actionService.findByPrimaryKey( nId );
 
         if ( action == null )
         {
             return null;
         }
 
         return getActionLabel( action );
     }
 
     private String getActionLabel( Action action )
     {
         IWorkflowService workflowService = SpringContextService.getBean( WorkflowService.BEAN_SERVICE );
         IStateService stateService = SpringContextService.getBean( StateService.BEAN_SERVICE );
 
         action.setWorkflow( workflowService.findByPrimaryKey( action.getWorkflow( ).getId( ) ) );
         action.setStateAfter( stateService.findByPrimaryKey( action.getStateAfter( ).getId( ) ) );
 
         StringBuilder sbTitle = new StringBuilder( );
         sbTitle.append( action.getWorkflow( ).getName( ) );
         sbTitle.append( "/" );
         sbTitle.append( action.getName( ) );
         sbTitle.append( " ( " );
         for ( Integer idStateBefore : action.getListIdStateBefore( ) )
         {
         	State stateBefore = stateService.findByPrimaryKey( idStateBefore );
         	sbTitle.append( stateBefore.getName( ) );
         	sbTitle.append( " " );
         }
         sbTitle.append( " -> " );
         sbTitle.append( action.getStateAfter( ).getName( ) );
         sbTitle.append( " ) " );
 
         return sbTitle.toString( );
     }
 }