View Javadoc
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.plugins.workflow.modules.actionsbatch.task;
35  
36  import java.util.List;
37  import java.util.Locale;
38  
39  import javax.servlet.http.HttpServletRequest;
40  
41  import org.apache.commons.collections.CollectionUtils;
42  import org.apache.commons.lang3.StringUtils;
43  
44  import fr.paris.lutece.api.user.User;
45  import fr.paris.lutece.plugins.workflow.modules.actionsbatch.service.ActionsBatchService;
46  import fr.paris.lutece.plugins.workflowcore.business.resource.ResourceHistory;
47  import fr.paris.lutece.plugins.workflowcore.service.config.ITaskConfigService;
48  import fr.paris.lutece.plugins.workflowcore.service.resource.IResourceHistoryService;
49  import fr.paris.lutece.plugins.workflowcore.service.resource.ResourceHistoryService;
50  import fr.paris.lutece.portal.service.admin.AdminAuthenticationService;
51  import fr.paris.lutece.portal.service.i18n.I18nService;
52  import fr.paris.lutece.portal.service.progressmanager.ProgressManagerService;
53  import fr.paris.lutece.portal.service.spring.SpringContextService;
54  import fr.paris.lutece.portal.service.workflow.WorkflowService;
55  
56  
57  public class ActionsBatchTask extends AsynchronousSimpleTask
58  {
59      private static final String PARAMETER_USER_ID = "userId";
60  
61      // Constants
62      private static final String TASK_TITLE = "module.workflow.actionsbatch.title";
63  
64      // Services
65      private static final IResourceHistoryService _resourceHistoryService = SpringContextService.getBean( ResourceHistoryService.BEAN_SERVICE );
66      private static final ITaskConfigService _taskConfigService = SpringContextService.getBean( "workflow-actionsbatch.actionsBatchTaskConfigService" );
67      private static final WorkflowService _workflowService = WorkflowService.getInstance( );
68      private static final ProgressManagerService _progressManagerService = ProgressManagerService.getInstance( );
69  
70      // params
71      private static final String PARAMETER_FEED_TOKEN = "FEED_TOKEN";
72  
73      @Override
74      public void processAsynchronousTask( int nIdResourceHistory, HttpServletRequest request, Locale locale )
75      {
76          // Get resource id as parent ID for processiing child actions
77          final ResourceHistory resourceHistory = _resourceHistoryService.findByPrimaryKey( nIdResourceHistory );
78          int parentId = resourceHistory.getId( );
79  
80          // get config
81          ActionsBatchTaskConfig config = _taskConfigService.findByPrimaryKey( getId( ) );
82  
83          if ( config != null && config.getIdAction( ) > 0 && config.getIdState( ) > 0 && !StringUtils.isBlank( config.getResourceType( ) ) )
84          {
85  
86              // get resource Ids
87              List<Integer> listResourceIds = _workflowService.getResourceIdListByIdState( config.getIdState( ), config.getResourceType( ) );
88  
89              // get user
90              User adminUser = AdminAuthenticationService.getInstance( ).getRegisteredUser( request );
91  
92              // get progress bar feed token and init feed
93              // (the progress feed must be registered upstream with ProgressManagerService.register( ...) 
94              // and set in the session to be used from the initial context in a template)
95              String strFeedToken = (String) request.getSession( ).getAttribute ( getFeedToken( ) );
96              _progressManagerService.initFeed( strFeedToken, listResourceIds.size( ) );
97  
98              if ( CollectionUtils.isNotEmpty( listResourceIds ) )
99              {
100                 ActionsBatchService.doProcessMassActions( request, config.getResourceType( ), config.getIdAction( ), resourceHistory.getIdResource( ), locale,
101                         adminUser, listResourceIds, true, strFeedToken );
102             }
103             else
104             {
105                 // unregister
106                 _progressManagerService.unRegisterFeed( strFeedToken );
107             }
108         }
109 
110     }
111 
112     @Override
113     public String getTitle( Locale pLocale )
114     {
115         return I18nService.getLocalizedString( TASK_TITLE, pLocale );
116     }
117 
118     /**
119      * get the feed token
120      * @return the token
121      */
122     private String getFeedToken( )
123     {
124             return new StringBuilder( "FEED-")
125             		.append( getAction( ).getResourceTypeCode( ) ).append( "-" )
126             		.append( getAction( ).getResourceId( ) ).append( "-" )
127             		.append( getAction( ).getWorkflow( ).getId( ) ).append( "-" )
128             		.append( getAction( ).getId( ) )
129                     .toString( );
130     }
131 }