View Javadoc
1   /*
2    * Copyright (c) 2002-2023, 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.document.web;
35  
36  import fr.paris.lutece.plugins.document.business.Document;
37  import fr.paris.lutece.plugins.document.business.DocumentHome;
38  import fr.paris.lutece.plugins.document.service.DocumentService;
39  import fr.paris.lutece.portal.business.right.Right;
40  import fr.paris.lutece.portal.business.right.RightHome;
41  import fr.paris.lutece.portal.business.user.AdminUser;
42  import fr.paris.lutece.portal.service.dashboard.DashboardComponent;
43  import fr.paris.lutece.portal.service.database.AppConnectionService;
44  import fr.paris.lutece.portal.service.plugin.Plugin;
45  import fr.paris.lutece.portal.service.plugin.PluginService;
46  import fr.paris.lutece.portal.service.template.AppTemplateService;
47  import fr.paris.lutece.util.html.HtmlTemplate;
48  import fr.paris.lutece.util.url.UrlItem;
49  
50  import org.apache.commons.lang3.StringUtils;
51  
52  import java.util.HashMap;
53  import java.util.Map;
54  
55  import javax.servlet.http.HttpServletRequest;
56  
57  
58  /**
59   * Calendar Dashboard Component
60   * This component displays directories
61   */
62  public class DocumentDashboardComponent extends DashboardComponent
63  {
64      // PARAMETERS
65      private static final String PARAMETER_PLUGIN_NAME = "plugin_name";
66  
67      // MARKS
68      private static final String MARK_URL = "url";
69      private static final String MARK_ICON = "icon";
70      private static final String MARK_LAST_MODIFIED_DOCUMENT = "last_modified_document";
71      private static final String MARK_LAST_PUBLISHED_DOCUMENT = "last_published_document";
72  
73      // TEMPALTES
74      private static final String TEMPLATE_DASHBOARD = "/admin/plugins/document/dashboard/document_dashboard.html";
75  
76      /**
77       * {@inheritDoc}
78       */
79      @Override
80      public String getDashboardData( AdminUser user, HttpServletRequest request )
81      {
82          Right right = RightHome.findByPrimaryKey( getRight(  ) );
83          Plugin plugin = PluginService.getPlugin( right.getPluginName(  ) );
84  
85          if ( !( ( plugin.getDbPoolName(  ) != null ) &&
86                  !AppConnectionService.NO_POOL_DEFINED.equals( plugin.getDbPoolName(  ) ) ) )
87          {
88              return StringUtils.EMPTY;
89          }
90  
91          // Get the last document the user was working on
92          Document lastModifiedDocument = DocumentHome.loadLastModifiedDocumentFromUser( user.getAccessCode(  ) );
93  
94          if ( lastModifiedDocument != null )
95          {
96              lastModifiedDocument.setLocale( user.getLocale(  ) );
97              DocumentService.getInstance(  ).getActions( lastModifiedDocument, user.getLocale(  ), user );
98              DocumentService.getInstance(  ).getPublishedStatus( lastModifiedDocument );
99          }
100 
101         // Get the last published document
102         Document lastPublishedDocument = DocumentHome.loadLastPublishedDocument(  );
103 
104         if ( lastPublishedDocument != null )
105         {
106             lastPublishedDocument.setLocale( user.getLocale(  ) );
107             DocumentService.getInstance(  ).getActions( lastPublishedDocument, user.getLocale(  ), user );
108             DocumentService.getInstance(  ).getPublishedStatus( lastPublishedDocument );
109         }
110 
111         UrlItem url = new UrlItem( right.getUrl(  ) );
112         url.addParameter( PARAMETER_PLUGIN_NAME, right.getPluginName(  ) );
113 
114         Map<String, Object> model = new HashMap<String, Object>(  );
115 
116         model.put( MARK_LAST_MODIFIED_DOCUMENT, lastModifiedDocument );
117         model.put( MARK_LAST_PUBLISHED_DOCUMENT, lastPublishedDocument );
118         model.put( MARK_URL, url.getUrl(  ) );
119         model.put( MARK_ICON, plugin.getIconUrl(  ) );
120 
121         HtmlTemplate t = AppTemplateService.getTemplate( TEMPLATE_DASHBOARD, user.getLocale(  ), model );
122 
123         return t.getHtml(  );
124     }
125 }