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.web.l10n;
35  
36  import fr.paris.lutece.portal.service.datastore.DatastoreService;
37  import fr.paris.lutece.portal.service.util.AppLogService;
38  
39  import java.util.Locale;
40  
41  import javax.servlet.http.HttpServletRequest;
42  import javax.servlet.http.HttpSession;
43  
44  
45  /**
46   * LocaleService
47   */
48  public final class LocaleService
49  {
50      private static final String ATTRIBUTE_SELECTED_LOCALE = "LUTECE_ATTRIBUTE_USER_SELECTED_LOCALE";
51      private static final String DSKEY_LANGUAGE_DEFAULT = "portal.site.site_property.locale.default";
52      private static final String LANGUAGE_DEFAULT = "en";
53      private static Locale _locale;
54  
55      /**
56       * Private constructor
57       */
58      private LocaleService(  )
59      {
60      }
61  
62      /**
63       * Set the locale selected by the user in the front office. The user may select a language
64       * without been authenticated.
65       * @param request The request
66       * @param locale The locale
67       */
68      public static void setUserSelectedLocale( HttpServletRequest request, Locale locale )
69      {
70          HttpSession session = request.getSession( true );
71          session.setAttribute( ATTRIBUTE_SELECTED_LOCALE, locale );
72      }
73  
74      /**
75       * Get a Locale selected by the user in front office
76       * @param request The HTTP request
77       * @return The locale selected, or the default jvm locale if no locale has been selected
78       */
79      public static Locale getUserSelectedLocale( HttpServletRequest request )
80      {
81          Locale locale = LocaleService.getDefault(  );
82          HttpSession session = request.getSession(  );
83  
84          if ( session != null )
85          {
86              Locale localeSession = (Locale) session.getAttribute( ATTRIBUTE_SELECTED_LOCALE );
87  
88              if ( localeSession != null )
89              {
90                  locale = localeSession;
91              }
92          }
93  
94          return locale;
95      }
96  
97      /**
98       * Return a Lutece defined default Locale
99       * @return The locale
100      */
101     public static Locale getDefault(  )
102     {
103         if ( _locale == null )
104         {
105             String strCountry = DatastoreService.getInstanceDataValue( DSKEY_LANGUAGE_DEFAULT, LANGUAGE_DEFAULT );
106 
107             for ( String strISOContry : Locale.getISOCountries(  ) )
108             {
109                 if ( strISOContry.equalsIgnoreCase( strCountry ) )
110                 {
111                     _locale = new Locale( strCountry );
112                     AppLogService.info( "LocaleService : default locale set to : " + strCountry );
113 
114                     return _locale;
115                 }
116             }
117 
118             _locale = Locale.getDefault(  );
119             AppLogService.error( "LocaleService : invalid defined locale " + strCountry + " - default set to " +
120                 LANGUAGE_DEFAULT );
121         }
122 
123         return _locale;
124     }
125 }