/**
    * This file Copyright (c) 2003-2015 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.cms.security.auth.callback;
  
  import info.magnolia.cms.beans.config.MIMEMapping;
  import info.magnolia.cms.i18n.Messages;
  import info.magnolia.cms.i18n.MessagesManager;
  import info.magnolia.cms.security.auth.login.LoginResult;
  import info.magnolia.cms.util.SimpleFreemarkerHelper;
  import info.magnolia.context.MgnlContext;
  import info.magnolia.init.MagnoliaConfigurationProperties;
  
  import java.util.HashMap;
  import java.util.Map;
  
  import javax.inject.Inject;
  import javax.security.auth.login.LoginException;
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  
  import org.apache.commons.lang3.ClassUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Renders a login form using Freemarker and the template configured with {@link #loginForm}.
   * This is using {@link SimpleFreemarkerUtil}, which means the configured {@link #loginForm} will only be loaded through
   * the classpath loader and won't have access to shared variables etc. For a more complex login form template,
   * re-implement a {@link HttpClientCallback} which uses {@link info.magnolia.freemarker.FreemarkerHelper} or the
   * {@link info.magnolia.rendering.engine.RenderingEngine}
   */
  public class FormClientCallback extends AbstractHttpClientCallback {
  
      private static final Logger log = LoggerFactory.getLogger(FormClientCallback.class);
  
      public static final String ERROR_STRING = "errorString";
      public static final String SERVICE_CONTACT = "serviceContact";
      private final SimpleFreemarkerHelper freemarkerHelper;
  
      private MagnoliaConfigurationProperties configurationProperties;
      private String loginForm;
  
      @Inject
      public FormClientCallback(MagnoliaConfigurationProperties configurationProperties) {
          this.configurationProperties = configurationProperties;
          this.freemarkerHelper = new SimpleFreemarkerHelper(getClass(), false);
      }
  
      @Override
      public void handle(HttpServletRequest request, HttpServletResponse response) {
          try {
              if (!response.isCommitted()) {
                  response.setContentType("text/html");
                  if (null == request.getCharacterEncoding()) {
                      response.setCharacterEncoding(MIMEMapping.getContentEncodingOrDefault("text/html"));
                  }
              }
              freemarkerHelper.render(getLoginForm(), getTemplateContext(), response.getWriter());
          } catch (Throwable t) {
              log.error("exception while writing login template", t);
          }
      }
  
      public String getLoginForm() {
          return loginForm;
      }
  
      public void setLoginForm(String loginForm) {
         this.loginForm = loginForm;
     }
 
     /**
      * @deprecated since 5.4, use {@link #getTemplateContext}
      */
     @Deprecated
     protected Map<String, Object> getMessages() {
         return new HashMap<>();
     }
 
     /**
      * Simply sets "errorString" in case of login exception.
      * Override this to pass more objects to the freemarker template.
      *
      * @return a map containing translated messages
      */
     protected Map<String, Object> getTemplateContext() {
         LoginResult loginResult = LoginResult.getCurrentLoginResult();
         LoginException exception = loginResult.getLoginException();
         Map<String, Object> tplCtx = new HashMap<String, Object>();
         if (null != exception) {
             final String exName = ClassUtils.getShortClassName(exception, null);
             final Messages mm = MessagesManager.getMessages();
             final String defaultMessage = mm.get("login.defaultError");
             tplCtx.put(ERROR_STRING, mm.getWithDefault("login." + exName, defaultMessage));
         }
         tplCtx.put("loginError", Boolean.valueOf(loginResult.getStatus() == LoginResult.STATUS_FAILED));
 
         String serviceContact = this.configurationProperties.getProperty("magnolia.service.contact");
         if (serviceContact != null) {
             tplCtx.put(SERVICE_CONTACT, serviceContact);
         }
 
         tplCtx.put("contextPath", MgnlContext.getContextPath());
 
         // In case someone extended getMessages()
         final Map<String, Object> deprecatedMethodResult = getMessages();
         tplCtx.putAll(deprecatedMethodResult);
         // TODO but what if they extended handle() and use getMessages there ?
 
         return tplCtx;
     }
 
 }