View Javadoc
1   /*
2    * Copyright (c) 2002-2021, 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.grafana.web;
35  
36  import fr.paris.lutece.plugins.grafana.business.Dashboard;
37  import fr.paris.lutece.plugins.grafana.business.DashboardHome;
38  import fr.paris.lutece.plugins.grafana.service.DashboardService;
39  import fr.paris.lutece.plugins.grafana.utils.constants.GrafanaConstants;
40  import fr.paris.lutece.portal.service.message.AdminMessage;
41  import fr.paris.lutece.portal.service.message.AdminMessageService;
42  import fr.paris.lutece.portal.util.mvc.admin.annotations.Controller;
43  import fr.paris.lutece.portal.util.mvc.commons.annotations.Action;
44  import fr.paris.lutece.portal.util.mvc.commons.annotations.View;
45  import fr.paris.lutece.util.url.UrlItem;
46  
47  import java.util.List;
48  import java.util.Map;
49  import javax.servlet.http.HttpServletRequest;
50  
51  /**
52   * This class provides the user interface to manage Dashboard features ( manage, create, modify, remove )
53   */
54  @Controller( controllerJsp = "ManageDashboards.jsp", controllerPath = "jsp/admin/plugins/grafana/", right = "GRAFANA_MANAGEMENT" )
55  public class DashboardJspBean extends ManageGrafanaJspBean
56  {
57      // Uid
58      private static final long serialVersionUID = 2675669204436156692L;
59  
60      // Templates
61      private static final String TEMPLATE_MANAGE_DASHBOARDS = "/admin/plugins/grafana/manage_dashboards.html";
62  
63      // Properties for page titles
64      private static final String PROPERTY_PAGE_TITLE_MANAGE_DASHBOARDS = "grafana.manage_dashboards.pageTitle";
65  
66      // Markers
67      private static final String MARK_DASHBOARD_LIST = "dashboard_list";
68  
69      // JSP
70      private static final String JSP_MANAGE_DASHBOARDS = "jsp/admin/plugins/grafana/ManageDashboards.jsp";
71  
72      // Messages
73      private static final String MESSAGE_CONFIRM_REMOVE_DASHBOARD = "grafana.remove_dashboard.confirm";
74  
75      // Views
76      private static final String VIEW_MANAGE_DASHBOARDS = "manageDashboards";
77  
78      // Actions
79      private static final String ACTION_IMPORT_DASHBOARDS = "importDashboards";
80      private static final String ACTION_CONFIRM_REMOVE_DASHBOARD = "confirmRemoveDashboard";
81      private static final String ACTION_REMOVE_DASHBOARD = "removeDashboard";
82  
83      /**
84       * Build the Manage View
85       * 
86       * @param request
87       *            The HTTP request
88       * @return The page
89       */
90      @View( value = VIEW_MANAGE_DASHBOARDS, defaultView = true )
91      public String getManageDashboards( HttpServletRequest request )
92      {
93          List<Dashboard> listDashboards = DashboardHome.getDashboardsList( );
94          Map<String, Object> model = getPaginatedListModel( request, MARK_DASHBOARD_LIST, listDashboards, JSP_MANAGE_DASHBOARDS );
95  
96          return getPage( PROPERTY_PAGE_TITLE_MANAGE_DASHBOARDS, TEMPLATE_MANAGE_DASHBOARDS, model );
97      }
98  
99      /**
100      * Import all dashboards from JSON to database. Insert only if it didnt exist.
101      * 
102      * @param request
103      * @return
104      */
105     @Action( value = ACTION_IMPORT_DASHBOARDS )
106     public String doImportDashboards( HttpServletRequest request )
107     {
108         DashboardService.getInstance( ).createAllDashboards( );
109         return redirectView( request, VIEW_MANAGE_DASHBOARDS );
110     }
111 
112     /**
113      * Ask admin user for confirmation about removing dashboard
114      *
115      * @param request
116      *            The Http request
117      * @return the html code to confirm
118      */
119     @Action( ACTION_CONFIRM_REMOVE_DASHBOARD )
120     public String getConfirmRemoveDashboard( HttpServletRequest request )
121     {
122         int nId = Integer.parseInt( request.getParameter( GrafanaConstants.PARAMETER_ID_DASHBOARD ) );
123         UrlItem url = new UrlItem( getActionUrl( ACTION_REMOVE_DASHBOARD ) );
124         url.addParameter( GrafanaConstants.PARAMETER_ID_DASHBOARD, nId );
125 
126         String strMessageUrl = AdminMessageService.getMessageUrl( request, MESSAGE_CONFIRM_REMOVE_DASHBOARD, url.getUrl( ), AdminMessage.TYPE_CONFIRMATION );
127 
128         return redirect( request, strMessageUrl );
129     }
130 
131     /**
132      * Import all dashboards from JSON to database. Insert only if it didnt exist.
133      * 
134      * @param request
135      * @return
136      */
137     @Action( value = ACTION_REMOVE_DASHBOARD )
138     public String doDeleteDashboard( HttpServletRequest request )
139     {
140         int nIdDashboard = Integer.parseInt( request.getParameter( GrafanaConstants.PARAMETER_ID_DASHBOARD ) );
141 
142         DashboardService.getInstance( ).deleteDashboard( nIdDashboard );
143 
144         return redirectView( request, VIEW_MANAGE_DASHBOARDS );
145     }
146 
147 }