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.portal.service.portlet;
35
36 import fr.paris.lutece.portal.business.page.Page;
37 import fr.paris.lutece.portal.business.page.PageHome;
38 import fr.paris.lutece.portal.business.portlet.Portlet;
39 import fr.paris.lutece.portal.business.user.AdminUser;
40 import fr.paris.lutece.portal.service.page.IPageService;
41 import fr.paris.lutece.portal.service.page.PageResourceIdService;
42 import fr.paris.lutece.portal.service.spring.SpringContextService;
43
44 import java.util.ArrayList;
45 import java.util.Collection;
46
47 /**
48 * class PortletService
49 */
50 public final class PortletService
51 {
52 private static PortletService _singleton;
53 private static IPageService _pageService = SpringContextService.getBean( "pageService" );
54
55 /**
56 * Constructor for class PortletService
57 *
58 */
59 private PortletService( )
60 {
61 }
62
63 /**
64 * Get the unique instance of the service
65 *
66 * @return The unique instance
67 */
68 public static synchronized PortletService getInstance( )
69 {
70 if ( _singleton == null )
71 {
72 _singleton = new PortletService( );
73 }
74
75 return _singleton;
76 }
77
78 /**
79 * Filter a collection of portlet associated to a given user
80 *
81 * @param collectionPortlet
82 * the The collection to filter
83 * @param user
84 * the current user
85 * @return a collection of portlet associated to a given user
86 */
87 public Collection<Portlet> getAuthorizedPortletCollection( Collection<Portlet> collectionPortlet, AdminUser user )
88 {
89 Collection<Portlet> collectionPortletAuthorized = new ArrayList<>( );
90
91 for ( Portlet portlet : collectionPortlet )
92 {
93 if ( _pageService.isAuthorizedAdminPage( portlet.getPageId( ), PageResourceIdService.PERMISSION_VIEW, user ) )
94 {
95 collectionPortletAuthorized.add( portlet );
96 }
97 }
98
99 return collectionPortletAuthorized;
100 }
101
102 /**
103 * Check if a portlet should be visible to the user
104 *
105 * @param idPortlet
106 * the id of the portlet
107 * @param user
108 * the current user
109 * @return true if authorized, otherwise false
110 */
111 public boolean isAuthorized( int idPortlet, AdminUser user )
112 {
113 Page page = PageHome.getPageByIdPortlet( idPortlet );
114
115 return _pageService.isAuthorizedAdminPage( page.getId( ), PageResourceIdService.PERMISSION_VIEW, user );
116 }
117
118 /**
119 * Check if a portlet should be visible to the user
120 *
121 * @param portlet
122 * the portlet
123 * @param user
124 * the current user
125 * @return true if authorized, otherwise false
126 */
127 public boolean isAuthorized( Portlet portlet, AdminUser user )
128 {
129 Page page = PageHome.findByPrimaryKey( portlet.getPageId( ) );
130
131 return _pageService.isAuthorizedAdminPage( page.getId( ), PageResourceIdService.PERMISSION_VIEW, user );
132 }
133 }