View Javadoc
1   /*
2    * Copyright (c) 2002-2017, Mairie de 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.directory.web;
35  
36  import fr.paris.lutece.plugins.directory.business.Directory;
37  import fr.paris.lutece.plugins.directory.business.DirectoryAction;
38  import fr.paris.lutece.plugins.directory.business.DirectoryActionHome;
39  import fr.paris.lutece.plugins.directory.business.DirectoryFilter;
40  import fr.paris.lutece.plugins.directory.business.DirectoryHome;
41  import fr.paris.lutece.plugins.directory.service.DirectoryPlugin;
42  import fr.paris.lutece.plugins.directory.service.DirectoryResourceIdService;
43  import fr.paris.lutece.plugins.directory.service.DirectoryService;
44  import fr.paris.lutece.portal.business.rbac.RBAC;
45  import fr.paris.lutece.portal.business.right.Right;
46  import fr.paris.lutece.portal.business.right.RightHome;
47  import fr.paris.lutece.portal.business.user.AdminUser;
48  import fr.paris.lutece.portal.service.dashboard.DashboardComponent;
49  import fr.paris.lutece.portal.service.database.AppConnectionService;
50  import fr.paris.lutece.portal.service.plugin.Plugin;
51  import fr.paris.lutece.portal.service.plugin.PluginService;
52  import fr.paris.lutece.portal.service.rbac.RBACService;
53  import fr.paris.lutece.portal.service.template.AppTemplateService;
54  import fr.paris.lutece.portal.service.workgroup.AdminWorkgroupService;
55  import fr.paris.lutece.util.html.HtmlTemplate;
56  import fr.paris.lutece.util.url.UrlItem;
57  
58  import java.util.ArrayList;
59  import java.util.HashMap;
60  import java.util.List;
61  import java.util.Map;
62  
63  import javax.servlet.http.HttpServletRequest;
64  
65  /**
66   * Calendar Dashboard Component This component displays directories
67   */
68  public class DirectoryDashboardComponent extends DashboardComponent
69  {
70      // MARKS
71      private static final String MARK_URL = "url";
72      private static final String MARK_ICON = "icon";
73      private static final String MARK_DIRECTORY_LIST = "directory_list";
74      private static final String MARK_RECORD_COUNT_LIST = "record_count_list";
75      private static final String MARK_AUTHORIZED_DIRECTORY_MODIFICATION_LIST = "authorized_directory_modification_list";
76      private static final String MARK_PERMISSION_CREATE = "permission_create";
77  
78      // CONSTANTS
79      private static final String EMPTY_STRING = "";
80  
81      // TEMPALTES
82      private static final String TEMPLATE_DASHBOARD = "/admin/plugins/directory/directory_dashboard.html";
83  
84      /**
85       * {@inheritDoc}
86       */
87      @Override
88      public String getDashboardData( AdminUser user, HttpServletRequest request )
89      {
90          Right right = RightHome.findByPrimaryKey( getRight( ) );
91          Plugin plugin = PluginService.getPlugin( right.getPluginName( ) );
92          List<DirectoryAction> listActions;
93          List<DirectoryAction> listActionsForDirectoryEnable;
94          List<DirectoryAction> listActionsForDirectoryDisable;
95  
96          if ( !( ( plugin.getDbPoolName( ) != null ) && !AppConnectionService.NO_POOL_DEFINED.equals( plugin.getDbPoolName( ) ) ) )
97          {
98              return EMPTY_STRING;
99          }
100 
101         UrlItem url = new UrlItem( right.getUrl( ) );
102         url.addParameter( DirectoryPlugin.PLUGIN_NAME, right.getPluginName( ) );
103 
104         Map<String, Object> model = new HashMap<String, Object>( );
105         List<Directory> directoryList = getDirectoryList( user, plugin );
106 
107         listActionsForDirectoryEnable = DirectoryActionHome.selectActionsByFormState( Directory.STATE_ENABLE, getPlugin( ), user.getLocale( ) );
108         listActionsForDirectoryDisable = DirectoryActionHome.selectActionsByFormState( Directory.STATE_DISABLE, getPlugin( ), user.getLocale( ) );
109 
110         Map<String, Object> recordCountMap = new HashMap<String, Object>( );
111         List<Integer> nAuthorizedModificationList = new ArrayList<Integer>( );
112 
113         for ( Directory directory : directoryList )
114         {
115             if ( directory.isEnabled( ) )
116             {
117                 listActions = listActionsForDirectoryEnable;
118             }
119             else
120             {
121                 listActions = listActionsForDirectoryDisable;
122             }
123 
124             listActions = (List<DirectoryAction>) RBACService.getAuthorizedActionsCollection( listActions, directory, user );
125             directory.setActions( listActions );
126 
127             if ( RBACService.isAuthorized( directory, DirectoryResourceIdService.PERMISSION_MODIFY, user ) )
128             {
129                 nAuthorizedModificationList.add( directory.getIdDirectory( ) );
130             }
131 
132             // count records
133             recordCountMap.put( Integer.toString( directory.getIdDirectory( ) ), DirectoryService.getInstance( ).getRecordsCount( directory, user ) );
134         }
135 
136         model.put( MARK_DIRECTORY_LIST, directoryList );
137         model.put( MARK_RECORD_COUNT_LIST, recordCountMap );
138         model.put( MARK_AUTHORIZED_DIRECTORY_MODIFICATION_LIST, nAuthorizedModificationList );
139 
140         model.put( MARK_URL, url.getUrl( ) );
141         model.put( MARK_ICON, plugin.getIconUrl( ) );
142         model.put( MARK_PERMISSION_CREATE,
143                 RBACService.isAuthorized( Directory.RESOURCE_TYPE, RBAC.WILDCARD_RESOURCES_ID, DirectoryResourceIdService.PERMISSION_CREATE, user ) );
144 
145         HtmlTemplate t = AppTemplateService.getTemplate( TEMPLATE_DASHBOARD, user.getLocale( ), model );
146 
147         return t.getHtml( );
148     }
149 
150     /**
151      * Get the list of directories
152      * 
153      * @param user
154      *            the current user
155      * @param plugin
156      *            Plugin
157      * @return the list of calendars
158      */
159     private List<Directory> getDirectoryList( AdminUser user, Plugin plugin )
160     {
161         DirectoryFilter filter = new DirectoryFilter( );
162         List<Directory> directoryList = DirectoryHome.getDirectoryList( filter, getPlugin( ) );
163 
164         return (List<Directory>) AdminWorkgroupService.getAuthorizedCollection( directoryList, user );
165     }
166 }