View Javadoc

1   /*
2    * Copyright (c) 2002-2014, 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.updater.web;
35  
36  import java.util.HashMap;
37  import java.util.Map;
38  
39  import javax.servlet.http.HttpServletRequest;
40  
41  import fr.paris.lutece.plugins.updater.service.IUpdateService;
42  import fr.paris.lutece.portal.business.right.Right;
43  import fr.paris.lutece.portal.business.right.RightHome;
44  import fr.paris.lutece.portal.business.user.AdminUser;
45  import fr.paris.lutece.portal.service.dashboard.DashboardComponent;
46  import fr.paris.lutece.portal.service.plugin.Plugin;
47  import fr.paris.lutece.portal.service.plugin.PluginService;
48  import fr.paris.lutece.portal.service.spring.SpringContextService;
49  import fr.paris.lutece.portal.service.template.AppTemplateService;
50  import fr.paris.lutece.util.html.HtmlTemplate;
51  import fr.paris.lutece.util.url.UrlItem;
52  import java.util.Collection;
53  
54  
55  /**
56   * Updater Dashboard Component : displays weither upgrades are available
57   */
58  public class UpdaterDashboardComponent extends DashboardComponent
59  {
60      private static final String TEMPLATE_DASHBOARD = "/admin/plugins/updater/updater_dashboard.html";
61      private static final String MARK_URL = "url";
62      private static final String MARK_STATUS = "status";
63      private static final String MARK_REGULAR_UPDATES = "regular_updates";
64      private static final String MARK_CRITICAL_UPDATES = "critical_updates";
65      private static final String PARAMETER_PLUGIN_NAME = "plugin_name";
66      private static final String BEAN_UPDATE_SERVICE = "updater.updateService";
67      private static final IUpdateService _updateService = (IUpdateService) SpringContextService.getBean( BEAN_UPDATE_SERVICE );
68  
69      /**
70       * The HTML code of the component
71       * @param user The Admin User
72       * @return The dashboard component
73       */
74      @Override
75      public String getDashboardData( AdminUser user, HttpServletRequest request )
76      {
77          Right right = RightHome.findByPrimaryKey( getRight(  ) );
78          UrlItem url = new UrlItem( right.getUrl(  ) );
79          url.addParameter( PARAMETER_PLUGIN_NAME, right.getPluginName(  ) );
80  
81          _updateService.checkUpdate( PluginService.getPluginList());
82  
83          Map<String, Object> model = new HashMap<String, Object>(  );
84          model.put( MARK_URL, url.getUrl(  ) );
85          model.put( MARK_STATUS, _updateService.getStatus(  ) );
86          model.put( MARK_REGULAR_UPDATES, _updateService.getRegularUpdateCount() );
87          model.put( MARK_CRITICAL_UPDATES, _updateService.getCriticalUpdateCount() );
88  
89          HtmlTemplate t = AppTemplateService.getTemplate( TEMPLATE_DASHBOARD, user.getLocale(  ), model );
90  
91          return t.getHtml(  );
92      }
93  }