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.mylutece.service.security;
35  
36  import fr.paris.lutece.portal.business.user.AdminUser;
37  import fr.paris.lutece.portal.service.datastore.DatastoreService;
38  import fr.paris.lutece.portal.service.security.SecurityService;
39  import fr.paris.lutece.portal.service.util.AppPathService;
40  import fr.paris.lutece.util.ReferenceItem;
41  import fr.paris.lutece.util.ReferenceList;
42  
43  import java.util.ArrayList;
44  import java.util.HashMap;
45  import java.util.List;
46  import java.util.Map;
47  
48  import javax.servlet.http.HttpServletRequest;
49  
50  /**
51   * This class provides public Url Service
52   */
53  public final class AuthenticationFilterService
54  {
55      /**
56       * Session attribute that stores the LuteceUser object attached to the session
57       */
58      public static final String MARK_PUBLIC_LIST_URL = "public_list_url";
59      public static final String PUBLIC_URL_PREFIX = "mylutece.security.public_url.";
60      public static final String MARK_PORTAL_AUTHENTICATION_REQUIRED = "portal_authentication_required";
61      private static final String MARK_LOCALE = "locale";
62      private static final String MARK_WEBAPP_URL = "webapp_url";
63      private static AuthenticationFilterServiceurity/AuthenticationFilterService.html#AuthenticationFilterService">AuthenticationFilterService _singleton = new AuthenticationFilterService( );
64  
65      /**
66       * Private constructor
67       */
68      private AuthenticationFilterService( )
69      {
70      }
71  
72      /**
73       * Get the unique instance of the Public url Service
74       * 
75       * @return The instance
76       */
77      public static AuthenticationFilterService getInstance( )
78      {
79          return _singleton;
80      }
81  
82      /**
83       * Build the advanced parameters management.
84       *
85       * @param user
86       *            the current admin user
87       * @param request
88       *            the request
89       * @return the model for the advanced parameters
90       */
91      public Map<String, Object> getManageAdvancedParameters( AdminUser user, HttpServletRequest request )
92      {
93          Map<String, Object> model = new HashMap<String, Object>( );
94          ReferenceList refListUrlPublic = DatastoreService.getDataByPrefix( PUBLIC_URL_PREFIX );
95  
96          for ( ReferenceItem refUrl : refListUrlPublic )
97          {
98              refUrl.setCode( refUrl.getCode( ).replace( PUBLIC_URL_PREFIX, "" ) );
99          }
100 
101         model.put( MARK_PORTAL_AUTHENTICATION_REQUIRED, SecurityService.getInstance( ).isPortalAuthenticationRequired( ) );
102         model.put( MARK_PUBLIC_LIST_URL, refListUrlPublic );
103         model.put( MARK_LOCALE, user.getLocale( ) );
104         model.put( MARK_WEBAPP_URL, AppPathService.getBaseUrl( request ) );
105 
106         return model;
107     }
108 
109     /**
110      * Gets the list of Public Urls defined in Security service Manage Advanced Parameters
111      * 
112      * @return a list of Public Urls
113      */
114     public List<String> getPublicUrls( )
115     {
116         ArrayList<String> lstPublicUrl = new ArrayList<String>( );
117         ReferenceList referenceListPublicUrl = DatastoreService.getDataByPrefix( PUBLIC_URL_PREFIX );
118 
119         if ( ( referenceListPublicUrl != null ) && !referenceListPublicUrl.isEmpty( ) )
120         {
121             for ( ReferenceItem item : referenceListPublicUrl )
122             {
123                 lstPublicUrl.add( item.getName( ) );
124             }
125         }
126 
127         return lstPublicUrl;
128     }
129 }