/*
    * 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.web;
  
  import fr.paris.lutece.api.user.User;
  import fr.paris.lutece.plugins.workflow.utils.WorkflowUtils;
  import fr.paris.lutece.plugins.workflowcore.business.workflow.Workflow;
  import fr.paris.lutece.plugins.workflowcore.business.workflow.WorkflowFilter;
  import fr.paris.lutece.plugins.workflowcore.service.workflow.IWorkflowService;
  import fr.paris.lutece.plugins.workflowcore.service.workflow.WorkflowService;
  import fr.paris.lutece.portal.business.right.Right;
  import fr.paris.lutece.portal.business.right.RightHome;
  import fr.paris.lutece.portal.business.user.AdminUser;
  import fr.paris.lutece.portal.service.dashboard.DashboardComponent;
  import fr.paris.lutece.portal.service.database.AppConnectionService;
  import fr.paris.lutece.portal.service.plugin.Plugin;
  import fr.paris.lutece.portal.service.plugin.PluginService;
  import fr.paris.lutece.portal.service.security.SecurityTokenService;
  import fr.paris.lutece.portal.service.spring.SpringContextService;
  import fr.paris.lutece.portal.service.template.AppTemplateService;
  import fr.paris.lutece.portal.service.workgroup.AdminWorkgroupService;
  import fr.paris.lutece.util.html.HtmlTemplate;
  import fr.paris.lutece.util.url.UrlItem;
  
  import org.apache.commons.lang3.StringUtils;
  
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  
  import javax.servlet.http.HttpServletRequest;
  
  /**
   * Calendar Dashboard Component This component displays directories
   */
  public class WorkflowDashboardComponent extends DashboardComponent
  {
      // MARKS
      private static final String MARK_URL = "url";
      private static final String MARK_ICON = "icon";
      private static final String MARK_WORKFLOW_LIST = "workflow_list";
  
      // PARAMETERS
      private static final String PARAMETER_PLUGIN_NAME = "plugin_name";
  
      // TEMPLATES
      private static final String TEMPLATE_DASHBOARD = "/admin/plugins/workflow/workflow_dashboard.html";
  
      // OTHER CONSTANTS
      private static final int FILTER_NO_STATUS = -1;
  
      /**
       * {@inheritDoc}
       */
      @Override
      public String getDashboardData( AdminUser user, HttpServletRequest request )
      {
          Right right = RightHome.findByPrimaryKey( getRight( ) );
          Plugin plugin = PluginService.getPlugin( right.getPluginName( ) );
  
          if ( !( ( plugin.getDbPoolName( ) != null ) && !AppConnectionService.NO_POOL_DEFINED.equals( plugin.getDbPoolName( ) ) ) )
          {
              return StringUtils.EMPTY;
          }
  
          IWorkflowService workflowService = SpringContextService.getBean( WorkflowService.BEAN_SERVICE );
  
          UrlItem url = new UrlItem( right.getUrl( ) );
         url.addParameter( PARAMETER_PLUGIN_NAME, right.getPluginName( ) );
 
         WorkflowFilter filter = new WorkflowFilter( );
         filter.setIsEnabled( FILTER_NO_STATUS );
         filter.setWorkGroup( AdminWorkgroupService.ALL_GROUPS );
 
         List<Workflow> listWorkflow = workflowService.getListWorkflowsByFilter( filter );
         listWorkflow = (List<Workflow>) AdminWorkgroupService.getAuthorizedCollection( listWorkflow, (User) user );
 
         Map<String, Object> model = new HashMap<>( );
         model.put( MARK_WORKFLOW_LIST, listWorkflow );
         model.put( MARK_URL, url.getUrl( ) );
         model.put( MARK_ICON, plugin.getIconUrl( ) );
         // Add CSRF Token
         model.put( SecurityTokenService.MARK_TOKEN , SecurityTokenService.getInstance( ).getToken( request, WorkflowUtils.CONSTANT_ACTION_MODIFY_WORKFLOW ) );
 
         HtmlTemplate t = AppTemplateService.getTemplate( TEMPLATE_DASHBOARD, user.getLocale( ), model );
 
         return t.getHtml( );
     }
 }