/**
    * This file Copyright (c) 2010-2011 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.module.blossom.support;
  
  import javax.servlet.http.HttpServletRequest;
  
  import org.apache.commons.lang.StringUtils;
  import org.springframework.web.util.WebUtils;
  
  /**
   * Request wrapper that makes the request appear like a forward operation. Also exposes the special attributes for a
   * forward request if they are not already set.
   *
   * @since 1.2
   */
  public class ForwardRequestWrapper extends SpecialAttributeRequestWrapper {
  
      private final String requestUri;
      private final String originalRequestUri;
      private final String contextPath;
      private final String originalContextPath;
      private final String servletPath;
      private final String originalServletPath;
      private final String pathInfo;
      private final String originalPathInfo;
  
      public ForwardRequestWrapper(HttpServletRequest request, String requestUri, String contextPath, String servletPath, String pathInfo) {
          super(request);
          this.requestUri = requestUri;
          this.originalRequestUri = request.getRequestURI();
          this.servletPath = servletPath;
          this.originalServletPath = request.getServletPath();
          this.contextPath = contextPath;
          this.originalContextPath = request.getContextPath();
          this.pathInfo = pathInfo;
          this.originalPathInfo = request.getPathInfo();
          if (request.getAttribute(WebUtils.FORWARD_REQUEST_URI_ATTRIBUTE) == null) {
              setSpecialAttribute(WebUtils.FORWARD_REQUEST_URI_ATTRIBUTE, request.getRequestURI());
              setSpecialAttribute(WebUtils.FORWARD_CONTEXT_PATH_ATTRIBUTE, request.getContextPath());
              setSpecialAttribute(WebUtils.FORWARD_SERVLET_PATH_ATTRIBUTE, request.getServletPath());
              setSpecialAttribute(WebUtils.FORWARD_PATH_INFO_ATTRIBUTE, request.getPathInfo());
              setSpecialAttribute(WebUtils.FORWARD_QUERY_STRING_ATTRIBUTE, request.getQueryString());
          }
      }
  
      @Override
      public String getRequestURI() {
          String currentRequestUri = super.getRequestURI();
          if (!StringUtils.equals(currentRequestUri, originalRequestUri)) {
              return currentRequestUri;
          }
          if (!StringUtils.equals(super.getServletPath(), originalServletPath)) {
              return currentRequestUri;
          }
          if (!StringUtils.equals(super.getPathInfo(), originalPathInfo)) {
              return currentRequestUri;
          }
          if (!StringUtils.equals(super.getContextPath(), originalContextPath)) {
              return currentRequestUri;
          }
          return requestUri;
      }
  
      @Override
      public String getContextPath() {
          String currentContextPath = super.getContextPath();
          if (!StringUtils.equals(super.getRequestURI(), originalRequestUri)) {
              return currentContextPath;
         }
         if (!StringUtils.equals(super.getServletPath(), originalServletPath)) {
             return currentContextPath;
         }
         if (!StringUtils.equals(super.getPathInfo(), originalPathInfo)) {
             return currentContextPath;
         }
         if (!StringUtils.equals(currentContextPath, originalContextPath)) {
             return currentContextPath;
         }
         return contextPath;
     }
 
     @Override
     public String getServletPath() {
         String currentServletPath = super.getServletPath();
         if (!StringUtils.equals(super.getRequestURI(), originalRequestUri)) {
             return currentServletPath;
         }
         if (!StringUtils.equals(currentServletPath, originalServletPath)) {
             return currentServletPath;
         }
         if (!StringUtils.equals(super.getPathInfo(), originalPathInfo)) {
             return currentServletPath;
         }
         if (!StringUtils.equals(super.getContextPath(), originalContextPath)) {
             return currentServletPath;
         }
         return servletPath;
     }
 
     @Override
     public String getPathInfo() {
         String superPathInfo = super.getPathInfo();
         if (!StringUtils.equals(super.getRequestURI(), originalRequestUri)) {
             return superPathInfo;
         }
         if (!StringUtils.equals(super.getServletPath(), originalServletPath)) {
             return superPathInfo;
         }
         if (!StringUtils.equals(superPathInfo, originalPathInfo)) {
             return superPathInfo;
         }
         if (!StringUtils.equals(super.getContextPath(), originalContextPath)) {
             return superPathInfo;
         }
         return pathInfo;
     }
 }