/*

  * Licensed to the Apache Software Foundation (ASF) under one

  * or more contributor license agreements.  See the NOTICE file

  * distributed with this work for additional information

  * regarding copyright ownership.  The ASF licenses this file

  * to you under the Apache License, Version 2.0 (the

  * "License"); you may not use this file except in compliance

  * with the License.  You may obtain a copy of the License at

  *

  *   http://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing,

  * software distributed under the License is distributed on an

  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

  * KIND, either express or implied.  See the License for the

  * specific language governing permissions and limitations

  * under the License.

  */

 package org.apache.myfaces.context.servlet;

 import java.io.IOException;

 import java.io.InputStream;

 import java.net.MalformedURLException;

 import java.net.URL;

 import java.security.Principal;

 import java.util.Iterator;

 import java.util.Locale;

 import java.util.Map;

 import java.util.Set;

 import javax.faces.FacesException;

 import javax.faces.context.ExternalContext;

 import javax.faces.context.FacesContext;

 import javax.servlet.RequestDispatcher;

 import javax.servlet.ServletContext;

 import javax.servlet.ServletException;

 import javax.servlet.ServletRequest;

 import javax.servlet.ServletResponse;

 import javax.servlet.http.HttpServletRequest;

 import javax.servlet.http.HttpServletResponse;

 import org.apache.myfaces.context.ReleaseableExternalContext;

 import org.apache.myfaces.util.EnumerationIterator;

 /**

  * Implements the external context for servlet request. JSF 1.2, 6.1.3

  * 

  * @author Manfred Geiler (latest modification by $Author: bommel $)

  * @author Anton Koinov

  * @version $Revision: 693059 $ $Date: 2008-09-08 06:42:28 -0500 (Mon, 08 Sep 2008) $

  */

 public final class ServletExternalContextImpl extends ExternalContext implements ReleaseableExternalContext

 {

     private static final String INIT_PARAMETER_MAP_ATTRIBUTE = InitParameterMap.class.getName();

     private ServletContext _servletContext;

     private ServletRequest _servletRequest;

     private ServletResponse _servletResponse;

     private Map<String, Object> _applicationMap;

     private Map<String, Object> _sessionMap;

     private Map<String, Object> _requestMap;

     private Map<String, String> _requestParameterMap;

     private Map<String, String[]> _requestParameterValuesMap;

     private Map<String, String> _requestHeaderMap;

     private Map<String, String[]> _requestHeaderValuesMap;

     private Map _requestCookieMap;

     private Map<String, String> _initParameterMap;

     private HttpServletRequest _httpServletRequest;

     private String _requestServletPath;

     private String _requestPathInfo;

     public ServletExternalContextImpl(final ServletContext servletContext, final ServletRequest servletRequest,

             final ServletResponse servletResponse)

     {

         _servletContext = servletContext;

         _servletRequest = servletRequest;

         _servletResponse = servletResponse;

         _applicationMap = null;

         _sessionMap = null;

         _requestMap = null;

         _requestParameterMap = null;

         _requestParameterValuesMap = null;

         _requestHeaderMap = null;

         _requestHeaderValuesMap = null;

         _requestCookieMap = null;

         _initParameterMap = null;

         _httpServletRequest = isHttpServletRequest(servletRequest) ? (HttpServletRequest) servletRequest : null;

         if (_httpServletRequest != null)

         {

             // HACK: MultipartWrapper scrambles the servletPath for some reason in Tomcat 4.1.29 embedded in JBoss

             // 3.2.3!?

             // (this was reported by frederic.auge [frederic.auge@laposte.net])

             _requestServletPath = _httpServletRequest.getServletPath();

             _requestPathInfo = _httpServletRequest.getPathInfo();

         }

     }

     public void release()

     {

         _servletContext = null;

         _servletRequest = null;

         _servletResponse = null;

         _applicationMap = null;

         _sessionMap = null;

         _requestMap = null;

         _requestParameterMap = null;

         _requestParameterValuesMap = null;

         _requestHeaderMap = null;

         _requestHeaderValuesMap = null;

         _requestCookieMap = null;

         _initParameterMap = null;

         _httpServletRequest = null;

     }

     @Override

     public Object getSession(boolean create)

     {

         checkHttpServletRequest();

         return ((HttpServletRequest) _servletRequest).getSession(create);

     }

     @Override

     public Object getContext()

     {

         return _servletContext;

     }

     @Override

     public Object getRequest()

     {

         return _servletRequest;

     }

     @Override

     public Object getResponse()

     {

         return _servletResponse;

     }

     @Override

     public String getResponseContentType()

     {

         return _servletResponse.getContentType();

     }

     @Override

     public Map<String, Object> getApplicationMap()

     {

         if (_applicationMap == null)

         {

             _applicationMap = new ApplicationMap(_servletContext);

         }

         return _applicationMap;

     }

     @Override

     public Map<String, Object> getSessionMap()

     {

         if (_sessionMap == null)

         {

             checkHttpServletRequest();

             _sessionMap = new SessionMap(_httpServletRequest);

         }

         return _sessionMap;

     }

     @Override

     public Map<String, Object> getRequestMap()

     {

         if (_requestMap == null)

         {

             _requestMap = new RequestMap(_servletRequest);

         }

         return _requestMap;

     }

     @Override

     public Map<String, String> getRequestParameterMap()

     {

         if (_requestParameterMap == null)

         {

             _requestParameterMap = new RequestParameterMap(_servletRequest);

         }

         return _requestParameterMap;

     }

     @Override

     public Map<String, String[]> getRequestParameterValuesMap()

     {

         if (_requestParameterValuesMap == null)

         {

             _requestParameterValuesMap = new RequestParameterValuesMap(_servletRequest);

         }

         return _requestParameterValuesMap;

     }

     @Override

     @SuppressWarnings("unchecked")

     public Iterator<String> getRequestParameterNames()

     {

         return new EnumerationIterator(_servletRequest.getParameterNames());

     }

     @Override

     public Map<String, String> getRequestHeaderMap()

     {

         if (_requestHeaderMap == null)

         {

             checkHttpServletRequest();

             _requestHeaderMap = new RequestHeaderMap(_httpServletRequest);

         }

         return _requestHeaderMap;

     }

     @Override

     public Map<String, String[]> getRequestHeaderValuesMap()

     {

         if (_requestHeaderValuesMap == null)

         {

             checkHttpServletRequest();

             _requestHeaderValuesMap = new RequestHeaderValuesMap(_httpServletRequest);

         }

         return _requestHeaderValuesMap;

     }

     @Override

     @SuppressWarnings("unchecked")

     public Map<String, Object> getRequestCookieMap()

     {

         if (_requestCookieMap == null)

         {

             checkHttpServletRequest();

             _requestCookieMap = new CookieMap(_httpServletRequest);

         }

         return _requestCookieMap;

     }

     @Override

     public Locale getRequestLocale()

     {

         return _servletRequest.getLocale();

     }

     @Override

     public String getRequestPathInfo()

     {

         checkHttpServletRequest();

         // return (_httpServletRequest).getPathInfo();

         // HACK: see constructor

         return _requestPathInfo;

     }

     @Override

     public String getRequestContentType()

     {

         return _servletRequest.getContentType();

     }

     @Override

     public String getRequestContextPath()

     {

         checkHttpServletRequest();

         return _httpServletRequest.getContextPath();

     }

     @Override

     public String getInitParameter(final String s)

     {

         return _servletContext.getInitParameter(s);

     }

     @Override

     @SuppressWarnings("unchecked")

     public Map<String, String> getInitParameterMap()

     {

         if (_initParameterMap == null)

         {

             // We cache it as an attribute in ServletContext itself (is this circular reference a problem?)

             if ((_initParameterMap = (Map<String, String>) _servletContext.getAttribute(INIT_PARAMETER_MAP_ATTRIBUTE)) == null)

             {

                 _initParameterMap = new InitParameterMap(_servletContext);

                 _servletContext.setAttribute(INIT_PARAMETER_MAP_ATTRIBUTE, _initParameterMap);

             }

         }

         return _initParameterMap;

     }

     @Override

     @SuppressWarnings("unchecked")

     public Set<String> getResourcePaths(final String path)

     {

         checkNull(path, "path");

         return _servletContext.getResourcePaths(path);

     }

     @Override

     public InputStream getResourceAsStream(final String path)

     {

         checkNull(path, "path");

         return _servletContext.getResourceAsStream(path);

     }

     @Override

     public String encodeActionURL(final String url)

     {

         checkNull(url, "url");

         checkHttpServletRequest();

         return ((HttpServletResponse) _servletResponse).encodeURL(url);

     }

     @Override

     public String encodeResourceURL(final String url)

     {

         checkNull(url, "url");

         checkHttpServletRequest();

         return ((HttpServletResponse) _servletResponse).encodeURL(url);

     }

     @Override

     public String encodeNamespace(final String s)

     {

         return s;

     }

     @Override

     public void dispatch(final String requestURI) throws IOException, FacesException

     {

         RequestDispatcher requestDispatcher = _servletRequest.getRequestDispatcher(requestURI);

         // If there is no dispatcher, send NOT_FOUND

         if (requestDispatcher == null)

         {

             ((HttpServletResponse) _servletResponse).sendError(HttpServletResponse.SC_NOT_FOUND);

             return;

         }

         try

         {

             requestDispatcher.forward(_servletRequest, _servletResponse);

         }

         catch (ServletException e)

         {

             if (e.getMessage() != null)

             {

                 throw new FacesException(e.getMessage(), e);

             }

             throw new FacesException(e);

         }

     }

     @Override

     public String getRequestServletPath()

     {

         checkHttpServletRequest();

         // return (_httpServletRequest).getServletPath();

         // HACK: see constructor

         return _requestServletPath;

     }

     @Override

     public String getAuthType()

     {

         checkHttpServletRequest();

         return _httpServletRequest.getAuthType();

     }

     @Override

     public String getRemoteUser()

     {

         checkHttpServletRequest();

         return _httpServletRequest.getRemoteUser();

     }

     @Override

     public boolean isUserInRole(final String role)

     {

         checkNull(role, "role");

         checkHttpServletRequest();

         return _httpServletRequest.isUserInRole(role);

     }

     @Override

     public Principal getUserPrincipal()

     {

         checkHttpServletRequest();

         return _httpServletRequest.getUserPrincipal();

     }

     @Override

     public void log(final String message)

     {

         checkNull(message, "message");

         _servletContext.log(message);

     }

     @Override

     public void log(final String message, final Throwable exception)

     {

         checkNull(message, "message");

         checkNull(exception, "exception");

         _servletContext.log(message, exception);

     }

     @Override

     public void redirect(final String url) throws IOException

     {

         if (_servletResponse instanceof HttpServletResponse)

         {

             ((HttpServletResponse) _servletResponse).sendRedirect(url);

             FacesContext.getCurrentInstance().responseComplete();

         }

         else

         {

             throw new IllegalArgumentException("Only HttpServletResponse supported");

         }

     }

     @SuppressWarnings("unchecked")

     public Iterator<Locale> getRequestLocales()

     {

         checkHttpServletRequest();

         return new EnumerationIterator(_httpServletRequest.getLocales());

     }

     @Override

     public URL getResource(final String path) throws MalformedURLException

     {

         checkNull(path, "path");

         return _servletContext.getResource(path);

     }

     /**

      * @since JSF 1.2

      * @param request

      */

     @Override

     public void setRequest(final java.lang.Object request)

     {

         this._servletRequest = (ServletRequest) request;

         this._httpServletRequest = isHttpServletRequest(_servletRequest) ? (HttpServletRequest) _servletRequest : null;

         this._httpServletRequest = isHttpServletRequest(_servletRequest) ? (HttpServletRequest) _servletRequest : null;

     }

     /**

      * @since JSF 1.2

      * @param encoding

      * @throws java.io.UnsupportedEncodingException

      */

     @Override

     public void setRequestCharacterEncoding(final java.lang.String encoding) throws java.io.UnsupportedEncodingException

     {

         this._servletRequest.setCharacterEncoding(encoding);

     }

     /**

      * @since JSF 1.2

      */

     @Override

     public String getRequestCharacterEncoding()

     {

         return _servletRequest.getCharacterEncoding();

     }

     /**

      * @since JSF 1.2

      */

     @Override

     public String getResponseCharacterEncoding()

     {

         return _servletResponse.getCharacterEncoding();

     }

     /**

      * @since JSF 1.2

      * @param response

      */

     @Override

     public void setResponse(final java.lang.Object response)

     {

         this._servletResponse = (ServletResponse) response;

     }

     /**

      * @since JSF 1.2

      * @param encoding

      */

     @Override

     public void setResponseCharacterEncoding(final java.lang.String encoding)

     {

         this._servletResponse.setCharacterEncoding(encoding);

     }

     private void checkNull(final Object o, final String param)

     {

         if (o == null)

         {

             throw new NullPointerException(param + " can not be null.");

         }

     }

     private void checkHttpServletRequest()

     {

         if (_httpServletRequest == null)

         {

             throw new UnsupportedOperationException("Only HttpServletRequest supported");

         }

     }

     private boolean isHttpServletRequest(final ServletRequest servletRequest)

     {

         return servletRequest instanceof HttpServletRequest;

     }

 }