View Javadoc

1   /**
2    * This file Copyright (c) 2003-2011 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.cms.security.auth.callback;
35  
36  import info.magnolia.cms.beans.config.MIMEMapping;
37  import info.magnolia.cms.i18n.Messages;
38  import info.magnolia.cms.i18n.MessagesManager;
39  import info.magnolia.cms.security.auth.login.LoginResult;
40  import info.magnolia.freemarker.FreemarkerUtil;
41  import info.magnolia.init.MagnoliaConfigurationProperties;
42  
43  import java.util.HashMap;
44  import java.util.Map;
45  
46  import javax.inject.Inject;
47  import javax.security.auth.login.LoginException;
48  import javax.servlet.http.HttpServletRequest;
49  import javax.servlet.http.HttpServletResponse;
50  
51  import org.apache.commons.lang.ClassUtils;
52  import org.slf4j.Logger;
53  import org.slf4j.LoggerFactory;
54  
55  /**
56   * Renders a login form using Freemarker and the template configured with {@link #loginForm}.
57   *
58   * $Id$
59   */
60  public class FormClientCallback extends AbstractHttpClientCallback {
61  
62      private static final Logger log = LoggerFactory.getLogger(FormClientCallback.class);
63  
64      public static final String ERROR_STRING = "errorString";
65      public static final String SERVICE_CONTACT = "serviceContact";
66  
67      private MagnoliaConfigurationProperties configurationProperties;
68      private String loginForm;
69  
70      @Inject
71      public FormClientCallback(MagnoliaConfigurationProperties configurationProperties) {
72          this.configurationProperties = configurationProperties;
73      }
74  
75      @Override
76      public void handle(HttpServletRequest request, HttpServletResponse response) {
77          try {
78              if (!response.isCommitted()) {
79                  response.setContentType("text/html");
80                  if (null == request.getCharacterEncoding()) {
81                      response.setCharacterEncoding(MIMEMapping.getContentEncodingOrDefault("text/html"));
82                  }
83              }
84              FreemarkerUtil.process(getLoginForm(), getMessages(), response.getWriter());
85          }
86          catch (Throwable t) {
87              log.error("exception while writing login template", t);
88          }
89      }
90  
91      public String getLoginForm() {
92          return loginForm;
93      }
94  
95      public void setLoginForm(String loginForm) {
96          this.loginForm = loginForm;
97      }
98  
99      /**
100      * simply sets "errorString" in case of login exception.
101      * override this to pass more objects to the freemarker template.
102      * @return an empty map
103      */
104     protected Map<String, Object> getMessages() {
105         LoginResult loginResult = LoginResult.getCurrentLoginResult();
106         LoginException exception = loginResult.getLoginException();
107         Map<String, Object> messages = new HashMap<String, Object>();
108         if (null != exception) {
109             final String exName = ClassUtils.getShortClassName(exception, null);
110             final Messages mm = MessagesManager.getMessages();
111             final String defaultMessage = mm.get("login.defaultError");
112             messages.put(ERROR_STRING, mm.getWithDefault("login." + exName, defaultMessage));
113         }
114         String serviceContact = this.configurationProperties.getProperty("magnolia.service.contact");
115         if (serviceContact != null) {
116             messages.put(SERVICE_CONTACT, serviceContact);
117         }
118         return messages;
119     }
120 
121 }