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.plugins.mylutece.modules.openid.web;
35  
36  import fr.paris.lutece.plugins.mylutece.web.MyLuteceApp;
37  import fr.paris.lutece.portal.service.i18n.I18nService;
38  import fr.paris.lutece.portal.service.plugin.Plugin;
39  import fr.paris.lutece.portal.service.template.AppTemplateService;
40  import fr.paris.lutece.portal.web.xpages.XPage;
41  import fr.paris.lutece.portal.web.xpages.XPageApplication;
42  import fr.paris.lutece.util.html.HtmlTemplate;
43  
44  import java.util.HashMap;
45  import java.util.Locale;
46  
47  import javax.servlet.http.HttpServletRequest;
48  
49  
50  /**
51   * OpenID XPage Application
52   */
53  public class OpenIDApp implements XPageApplication
54  {
55      // Parameters
56      public static final String PARAMETER_PAGE = "page";
57      public static final String PARAMETER_PAGE_VALUE = "openid";
58      public static final String PARAMETER_ERROR = "error";
59      private static final String PARAMETER_ACTION = "action";
60  
61      // Templates
62      private static final String TEMPLATE_LOGIN_PAGE = "skin/plugins/mylutece/modules/openid/login_form.html";
63  
64      // Markers
65      private static final String MARK_ERROR_MESSAGE = "error_message";
66      private static final String MARK_URL_DOLOGIN = "url_dologin";
67  
68      // Actions
69      private static final String ACTION_LOGIN = "login";
70      private static final String PROPERTY_PAGETITLE_LOGIN = "module.mylutece.openid.loginPageTitle";
71      private static final String PROPERTY_PATHLABEL_LOGIN = "module.mylutece.openid.loginPagePath";
72  
73      /**
74       * Build the XPage
75       * @param request The HTTP request
76       * @param nMode The current mode
77       * @param plugin The current plugin
78       * @return The XPage
79       */
80      public XPage getPage( HttpServletRequest request, int nMode, Plugin plugin )
81      {
82          XPage page = new XPage(  );
83  
84          String strAction = request.getParameter( PARAMETER_ACTION );
85          Locale locale = request.getLocale(  );
86  
87          if ( ( strAction == null ) || strAction.equals( ACTION_LOGIN ) )
88          {
89              return getLoginPage( page, request, locale );
90          }
91  
92          return page;
93      }
94  
95      /**
96       * Build the Login page
97       * @param page The XPage object to fill
98       * @param request The HTTP request
99       * @param locale The current locale
100      * @return The XPage object containing the page content
101      */
102     private XPage getLoginPage( XPage page, HttpServletRequest request, Locale locale )
103     {
104         HashMap model = new HashMap(  );
105 
106         String strError = request.getParameter( PARAMETER_ERROR );
107         String strErrorMessage = "";
108 
109         if ( strError != null )
110         {
111             strErrorMessage = I18nService.getLocalizedString( strError, locale );
112         }
113 
114         model.put( MARK_ERROR_MESSAGE, strErrorMessage );
115         model.put( MARK_URL_DOLOGIN, MyLuteceApp.getDoLoginUrl(  ) );
116 
117         HtmlTemplate template = AppTemplateService.getTemplate( TEMPLATE_LOGIN_PAGE, locale, model );
118 
119         page.setContent( template.getHtml(  ) );
120         page.setTitle( I18nService.getLocalizedString( PROPERTY_PAGETITLE_LOGIN, locale ) );
121         page.setPathLabel( I18nService.getLocalizedString( PROPERTY_PATHLABEL_LOGIN, locale ) );
122 
123         return page;
124     }
125 }