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.notification.web;
35  
36  import fr.paris.lutece.plugins.workflow.utils.WorkflowUtils;
37  import fr.paris.lutece.plugins.workflow.web.task.NoFormTaskComponent;
38  import fr.paris.lutece.plugins.workflowcore.business.config.ITaskConfig;
39  import fr.paris.lutece.plugins.workflowcore.service.task.ITask;
40  import fr.paris.lutece.portal.service.admin.AdminUserService;
41  import fr.paris.lutece.portal.service.i18n.I18nService;
42  import fr.paris.lutece.portal.service.mailinglist.AdminMailingListService;
43  import fr.paris.lutece.portal.service.template.AppTemplateService;
44  import fr.paris.lutece.util.ReferenceList;
45  import fr.paris.lutece.util.html.HtmlTemplate;
46  
47  import java.util.HashMap;
48  import java.util.Locale;
49  import java.util.Map;
50  
51  import javax.servlet.http.HttpServletRequest;
52  
53  /**
54   *
55   * NotificationTaskComponent
56   *
57   */
58  public class NotificationTaskComponent extends NoFormTaskComponent
59  {
60      // TEMPLATES
61      private static final String TEMPLATE_TASK_NOTIFICATION_CONFIG = "admin/plugins/workflow/modules/notification/task_notification_config.html";
62  
63      // MARKS
64      private static final String MARK_CONFIG = "config";
65      private static final String MARK_MAILING_LIST = "mailing_list";
66      private static final String MARK_DEFAULT_SENDER_NAME = "default_sender_name";
67  
68      // PROPERTIES
69      private static final String PROPERTY_NOTIFICATION_MAIL_DEFAULT_SENDER_NAME = "module.workflow.notification.notification_mail.default_sender_name";
70      private static final String PROPERTY_SELECT_EMPTY_CHOICE = "module.workflow.notification.task_notification_config.label_empty_choice";
71  
72      // SERVICES
73  
74      /**
75       * {@inheritDoc}
76       */
77      @Override
78      public String getDisplayConfigForm( HttpServletRequest request, Locale locale, ITask task )
79      {
80          Map<String, Object> model = new HashMap<>( );
81          String strNothing = I18nService.getLocalizedString( PROPERTY_SELECT_EMPTY_CHOICE, locale );
82          ReferenceList refMailingList = new ReferenceList( );
83          refMailingList.addItem( WorkflowUtils.CONSTANT_ID_NULL, strNothing );
84          refMailingList.addAll( AdminMailingListService.getMailingLists( AdminUserService.getAdminUser( request ) ) );
85  
86          ITaskConfig config = this.getTaskConfigService( ).findByPrimaryKey( task.getId( ) );
87          String strDefaultSenderName = I18nService.getLocalizedString( PROPERTY_NOTIFICATION_MAIL_DEFAULT_SENDER_NAME, locale );
88          model.put( MARK_CONFIG, config );
89          model.put( MARK_MAILING_LIST, refMailingList );
90          model.put( MARK_DEFAULT_SENDER_NAME, strDefaultSenderName );
91  
92          HtmlTemplate template = AppTemplateService.getTemplate( TEMPLATE_TASK_NOTIFICATION_CONFIG, locale, model );
93  
94          return template.getHtml( );
95      }
96  
97      /**
98       * {@inheritDoc}
99       */
100     @Override
101     public String getDisplayTaskInformation( int nIdHistory, HttpServletRequest request, Locale locale, ITask task )
102     {
103         return null;
104     }
105 }