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.portal.service.theme;
35  
36  import fr.paris.lutece.portal.business.theme.ThemeHome;
37  import fr.paris.lutece.portal.business.style.Theme;
38  
39  import fr.paris.lutece.portal.service.portal.IThemeService;
40  import fr.paris.lutece.util.ReferenceList;
41  
42  import java.util.Collection;
43  
44  import javax.servlet.http.Cookie;
45  import javax.servlet.http.HttpServletRequest;
46  
47  
48  /**
49   *
50   * ThemeService
51   *
52   */
53  public class ThemeService implements IThemeService
54  {
55          /**
56       * Init
57       */
58      public void init( )
59      {
60  
61      }
62  
63  
64      /**
65      * Get the list of themes
66      * @return a list of themes
67      */
68      public ReferenceList getThemes( )
69      {
70          return ThemeHome.getThemes( );
71      }
72  
73      /**
74       * Get the theme with a given code theme
75       * @param strCodeTheme the code theme
76       * @return the theme
77       */
78      public Theme getTheme( String strCodeTheme )
79      {
80          return ThemeHome.findByPrimaryKey( strCodeTheme );
81      }
82  
83      /**
84       * Get the global theme
85       * @return the global theme
86       */
87      public Theme getGlobalTheme( )
88      {
89          return ThemeHome.getGlobalTheme( );
90      }
91  
92      /**
93      * Gets the theme selected by the user
94      *
95      * @param request The HTTP request
96      * @return The theme if available otherwise null
97      */
98      public String getUserTheme( HttpServletRequest request )
99      {
100         if ( request != null )
101         {
102             Cookie[] cookies = request.getCookies( );
103 
104             if ( cookies != null )
105             {
106                 for ( int i = 0; i < cookies.length; i++ )
107                 {
108                     Cookie cookie = cookies[i];
109 
110                     if ( cookie.getName(  ).equalsIgnoreCase( ThemeUtil.COOKIE_NAME ) )
111                     {
112                         String strTheme = cookie.getValue( );
113 
114                         if ( ThemeHome.isValidTheme( strTheme ) )
115                         {
116                             return strTheme;
117                         }
118                     }
119                 }
120             }
121         }
122 
123         return null;
124     }
125 
126     /**
127      * Return the list of all the themes
128      *
129      * @return A collection of themes objects
130      */
131     public Collection<Theme> getThemesList(  )
132     {
133         return ThemeHome.getThemesList(  );
134     }
135 
136     /**
137          * Set the global theme
138          * @param strGlobalTheme the code theme of the global theme
139          */
140     public void setGlobalTheme( String strGlobalTheme, String strGlobalThemeVersion )
141     {
142         ThemeHome.setGlobalTheme( strGlobalTheme, strGlobalThemeVersion );
143     }
144 
145     /**
146     * Checks if the theme is among existing themes
147     *
148     * @param strCodeTheme The theme to check
149     * @return True if the theme is valid
150     */
151     public boolean isValidTheme( String strCodeTheme )
152     {
153         return ThemeHome.isValidTheme( strCodeTheme );
154     }
155 }