/*

  * Copyright 1999,2004 The Apache Software Foundation.

  * 

  * Licensed 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.commons.messagelet.impl;

 import java.io.UnsupportedEncodingException;

 import java.security.Principal;

 import java.text.ParseException;

 import java.text.SimpleDateFormat;

 import java.util.ArrayList;

 import java.util.Collections;

 import java.util.Date;

 import java.util.Enumeration;

 import java.util.HashMap;

 import java.util.Locale;

 import java.util.Map;

 import javax.servlet.ServletContext;

 import javax.servlet.http.Cookie;

 import javax.servlet.http.HttpServletRequest;

 import javax.servlet.http.HttpSession;

 import org.apache.commons.collections.iterators.IteratorEnumeration;

 /**

  * Based on the HttpRequestBase code from Catalina.

  *

  * @author Craig R. McClanahan

  * @author James Strachan

  * @version $Revision: 155459 $ $Date: 2005-02-26 13:24:44 +0000 (Sat, 26 Feb 2005) $

  */

 public class HttpServletRequestImpl extends ServletRequestImpl implements HttpServletRequest {

     /**

      * The authentication type used for this request.

      */

     protected String authType = null;

     /**

      * The context path for this request.

      */

     protected String contextPath = "";

     /**

      * The set of cookies associated with this Request.

      */

     protected ArrayList cookies = new ArrayList();

     /**

      * The set of SimpleDateFormat formats to use in getDateHeader().

      */

     protected SimpleDateFormat formats[] = {

         new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss zzz", Locale.US),

         new SimpleDateFormat("EEEEEE, dd-MMM-yy HH:mm:ss zzz", Locale.US),

         new SimpleDateFormat("EEE MMMM d HH:mm:ss yyyy", Locale.US)

     };

     /**

      * The HTTP headers associated with this Request, keyed by name.  The

      * values are ArrayLists of the corresponding header values.

      */

     protected HashMap headers = new HashMap();

     /**

      * The request method associated with this Request.

      */

     protected String method = null;

     /**

      * The path information for this request.

      */

     protected String pathInfo = null;

     /**

      * The query string for this request.

      */

     protected String queryString = null;

     /**

      * Was the requested session ID received in a cookie?

      */

     protected boolean requestedSessionCookie = false;

     /**

      * The requested session ID (if any) for this request.

      */

     protected String requestedSessionId = null;

     /**

      * Was the requested session ID received in a URL?

      */

     protected boolean requestedSessionURL = false;

     /**

      * The request URI associated with this request.

      */

     protected String requestURI = null;

     /**

      * The servlet path for this request.

      */

     protected String servletPath = null;

     /**

      * The currently active session for this request.

      */

     protected HttpSessionImpl session = null;

     /**

      * The Principal who has been authenticated for this Request.

      */

     protected Principal userPrincipal = null;

     /**

      * The parameters 

      */

     private Map parameters = null;

     // --------------------------------------------------------- Public Methods

     public HttpServletRequestImpl(ServletContext servletContext) {

         super( servletContext );

     }

     /**

      * Add a Cookie to the set of Cookies associated with this Request.

      *

      * @param cookie The new cookie

      */

     public void addCookie(Cookie cookie) {

         synchronized (cookies) {

             cookies.add(cookie);

         }

     }

     /**

      * Add a Header to the set of Headers associated with this Request.

      *

      * @param name The new header name

      * @param value The new header value

      */

     public void addHeader(String name, String value) {

         name = name.toLowerCase();

         synchronized (headers) {

             ArrayList values = (ArrayList) headers.get(name);

             if (values == null) {

                 values = new ArrayList();

                 headers.put(name, values);

             }

             values.add(value);

         }

     }

     /**

      * Clear the collection of Cookies associated with this Request.

      */

     public void clearCookies() {

         synchronized (cookies) {

             cookies.clear();

         }

     }

     /**

      * Clear the collection of Headers associated with this Request.

      */

     public void clearHeaders() {

         headers.clear();

     }

     /**

      * Set the authentication type used for this request, if any; otherwise

      * set the type to <code>null</code>.  Typical values are "BASIC",

      * "DIGEST", or "SSL".

      *

      * @param authType The authentication type used

      */

     public void setAuthType(String authType) {

         this.authType = authType;

     }

     /**

      * Set the context path for this Request.  This will normally be called

      * when the associated Context is mapping the Request to a particular

      * Wrapper.

      *

      * @param path The context path

      */

     public void setContextPath(String path) {

         if (path == null)

             this.contextPath = "";

         else

             this.contextPath = path;

     }

     /**

      * Set the HTTP request method used for this Request.

      *

      * @param method The request method

      */

     public void setMethod(String method) {

         this.method = method;

     }

     /**

      * Set the path information for this Request.  This will normally be called

      * when the associated Context is mapping the Request to a particular

      * Wrapper.

      *

      * @param path The path information

      */

     public void setPathInfo(String path) {

         this.pathInfo = path;

     }

     /**

      * Set the query string for this Request.  This will normally be called

      * by the HTTP Connector, when it parses the request headers.

      *

      * @param query The query string

      */

     public void setQueryString(String query) {

         this.queryString = query;

         this.parameters = null;

     }

     /**

      * Set a flag indicating whether or not the requested session ID for this

      * request came in through a cookie.  This is normally called by the

      * HTTP Connector, when it parses the request headers.

      *

      * @param flag The new flag

      */

     public void setRequestedSessionCookie(boolean flag) {

         this.requestedSessionCookie = flag;

     }

     /**

      * Set the requested session ID for this request.  This is normally called

      * by the HTTP Connector, when it parses the request headers.

      *

      * @param id The new session id

      */

     public void setRequestedSessionId(String id) {

         this.requestedSessionId = id;

     }

     /**

      * Set a flag indicating whether or not the requested session ID for this

      * request came in through a URL.  This is normally called by the

      * HTTP Connector, when it parses the request headers.

      *

      * @param flag The new flag

      */

     public void setRequestedSessionURL(boolean flag) {

         this.requestedSessionURL = flag;

     }

     /**

      * Set the unparsed request URI for this Request.  This will normally

      * be called by the HTTP Connector, when it parses the request headers.

      *

      * @param uri The request URI

      */

     public void setRequestURI(String uri) {

         this.requestURI = uri;

     }

     /**

      * Set the servlet path for this Request.  This will normally be called

      * when the associated Context is mapping the Request to a particular

      * Wrapper.

      *

      * @param path The servlet path

      */

     public void setServletPath(String path) {

         this.servletPath = path;

     }

     /**

      * Set the Principal who has been authenticated for this Request.  This

      * value is also used to calculate the value to be returned by the

      * <code>getRemoteUser()</code> method.

      *

      * @param principal The user Principal

      */

     public void setUserPrincipal(Principal principal) {

         this.userPrincipal = principal;

     }

     // --------------------------------------------- HttpServletRequest Methods

     /**

      * Return the authentication type used for this Request.

      */

     public String getAuthType() {

         return (authType);

     }

     /**

      * Return the portion of the request URI used to select the Context

      * of the Request.

      */

     public String getContextPath() {

         return (contextPath);

     }

     /**

      * Return the set of Cookies received with this Request.

      */

     public Cookie[] getCookies() {

         synchronized (cookies) {

             if (cookies.size() < 1)

                 return (null);

             Cookie results[] = new Cookie[cookies.size()];

             return ((Cookie[]) cookies.toArray(results));

         }

     }

     /**

      * Return the value of the specified date header, if any; otherwise

      * return -1.

      *

      * @param name Name of the requested date header

      *

      * @exception IllegalArgumentException if the specified header value

      *  cannot be converted to a date

      */

     public long getDateHeader(String name) {

         String value = getHeader(name);

         if (value == null)

             return (-1L);

         // Work around a bug in SimpleDateFormat in pre-JDK1.2b4

         // (Bug Parade bug #4106807)

         value += " ";

         // Attempt to convert the date header in a variety of formats

         for (int i = 0; i < formats.length; i++) {

             try {

                 Date date = formats[i].parse(value);

                 return (date.getTime());

             } catch (ParseException e) {

                 ;

             }

         }

         throw new IllegalArgumentException(value);

     }

     /**

      * Return the first value of the specified header, if any; otherwise,

      * return <code>null</code>

      *

      * @param name Name of the requested header

      */

     public String getHeader(String name) {

         name = name.toLowerCase();

         synchronized (headers) {

             ArrayList values = (ArrayList) headers.get(name);

             if (values != null)

                 return ((String) values.get(0));

             else

                 return (null);

         }

     }

     /**

      * Return all of the values of the specified header, if any; otherwise,

      * return an empty enumeration.

      *

      * @param name Name of the requested header

      */

     public Enumeration getHeaders(String name) {

         name = name.toLowerCase();

         synchronized (headers) {

             ArrayList values = (ArrayList) headers.get(name);

             if (values != null)

                 return (new IteratorEnumeration( values.iterator() ));

             else

                 return (new IteratorEnumeration( Collections.EMPTY_LIST.iterator() ));

         }

     }

     /**

      * Return the names of all headers received with this request.

      */

     public Enumeration getHeaderNames() {

         synchronized (headers) {

             return (new IteratorEnumeration( headers.keySet().iterator() ));

         }

     }

     /**

      * Return the value of the specified header as an integer, or -1 if there

      * is no such header for this request.

      *

      * @param name Name of the requested header

      *

      * @exception IllegalArgumentException if the specified header value

      *  cannot be converted to an integer

      */

     public int getIntHeader(String name) {

         String value = getHeader(name);

         if (value == null)

             return (-1);

         else

             return (Integer.parseInt(value));

     }

     /**

      * Return the HTTP request method used in this Request.

      */

     public String getMethod() {

         return (method);

     }

     /**

      * Returns a <code>Map</code> of the parameters of this request.

      * Request parameters are extra information sent with the request.

      * For HTTP servlets, parameters are contained in the query string

      * or posted form data.

      *

      * @return A <code>Map</code> containing parameter names as keys

      *  and parameter values as map values.

      */

     public Map getParameterMap() {

         if ( parameters == null ) {

             parameters = new HashMap();

             if ( queryString != null ) {

                 try {

                     RequestUtil.parseParameters(parameters, queryString, getCharacterEncoding());

                 }

                 catch (UnsupportedEncodingException e) {

                     servletContext.log( "Could not parse query string: " + queryString, e);

                 }

             }

         }

         return parameters;

     }

     /**

      * Return the path information associated with this Request.

      */

     public String getPathInfo() {

         return (pathInfo);

     }

     /**

      * Return the extra path information for this request, translated

      * to a real path.

      */

     public String getPathTranslated() {

         if (pathInfo == null)

             return (null);

         else

             return (servletContext.getRealPath(pathInfo));

     }

     /**

      * Return the query string associated with this request.

      */

     public String getQueryString() {

         return (queryString);

     }

     /**

      * Return the name of the remote user that has been authenticated

      * for this Request.

      */

     public String getRemoteUser() {

         if (userPrincipal != null)

             return (userPrincipal.getName());

         else

             return (null);

     }

     /**

      * Return the session identifier included in this request, if any.

      */

     public String getRequestedSessionId() {

         return (requestedSessionId);

     }

     /**

      * Return the request URI for this request.

      */

     public String getRequestURI() {

         return (requestURI);

     }

     /**

      * Reconstructs the URL the client used to make the request.

      * The returned URL contains a protocol, server name, port

      * number, and server path, but it does not include query

      * string parameters.

      * <p>

      * Because this method returns a <code>StringBuffer</code>,

      * not a <code>String</code>, you can modify the URL easily,

      * for example, to append query parameters.

      * <p>

      * This method is useful for creating redirect messages and

      * for reporting errors.

      *

      * @return A <code>StringBuffer</code> object containing the

      *  reconstructed URL

      */

     public StringBuffer getRequestURL() {

         StringBuffer url = new StringBuffer();

         String scheme = getScheme();

         int port = getServerPort();

         if (port < 0)

             port = 80; // Work around java.net.URL bug

         url.append(scheme);

         url.append("://");

         url.append(getServerName());

         if ((scheme.equals("http") && (port != 80))

             || (scheme.equals("https") && (port != 443))) {

             url.append(':');

             url.append(port);

         }

         url.append(getRequestURI());

         return (url);

     }

     /**

      * Return the portion of the request URI used to select the servlet

      * that will process this request.

      */

     public String getServletPath() {

         return (servletPath);

     }

     /**

      * Return the session associated with this Request, creating one

      * if necessary.

      */

     public HttpSession getSession() {

         return (getSession(true));

     }

     /**

      * Return the session associated with this Request, creating one

      * if necessary and requested.

      *

      * @param create Create a new session if one does not exist

      */

     public HttpSession getSession(boolean create) {

         // Return the current session if it exists and is valid

         if ((session != null) && !session.isValid())

             session = null;

         if ( create && session == null) {

             session = new HttpSessionImpl( servletContext );

         }

         return session;

     }

     /**

      * Return <code>true</code> if the session identifier included in this

      * request came from a cookie.

      */

     public boolean isRequestedSessionIdFromCookie() {

         if (requestedSessionId != null)

             return (requestedSessionCookie);

         else

             return (false);

     }

     /**

      * Return <code>true</code> if the session identifier included in this

      * request came from the request URI.

      */

     public boolean isRequestedSessionIdFromURL() {

         if (requestedSessionId != null)

             return (requestedSessionURL);

         else

             return (false);

     }

     /**

      * Return <code>true</code> if the session identifier included in this

      * request came from the request URI.

      *

      * @deprecated As of Version 2.1 of the Java Servlet API, use

      *  <code>isRequestedSessionIdFromURL()</code> instead.

      */

     public boolean isRequestedSessionIdFromUrl() {

         return (isRequestedSessionIdFromURL());

     }

     /**

      * Return <code>true</code> if the session identifier included in this

      * request identifies a valid session.

      */

     public boolean isRequestedSessionIdValid() {

         return false;

     }

     /**

      * Return <code>true</code> if the authenticated user principal

      * possesses the specified role name.

      *

      * @param role Role name to be validated

      */

     public boolean isUserInRole(String role) {  

         return false;

     }

     /**

      * Return the principal that has been authenticated for this Request.

      */

     public Principal getUserPrincipal() {

         return (userPrincipal);

     }

 }