/*

   * 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.wicket.protocol.http;

 import java.io.IOException;

 import java.io.OutputStream;

 import java.util.Locale;

 import javax.servlet.http.Cookie;

 import javax.servlet.http.HttpServletResponse;

 import org.apache.wicket.Response;

 import org.apache.wicket.WicketRuntimeException;

 import org.apache.wicket.util.string.AppendingStringBuffer;

 import org.apache.wicket.util.string.Strings;

 import org.apache.wicket.util.time.Time;

 import org.slf4j.Logger;

 import org.slf4j.LoggerFactory;

 public class WebResponse extends Response

 {
	

 	private static final Logger log = LoggerFactory.getLogger(WebResponse.class);

	

 	protected boolean redirect;

	

 	private final HttpServletResponse httpServletResponse;

	

 	private boolean ajax;

	

 	public WebResponse()

 	{

 		httpServletResponse = null;

 	}

	

 	public WebResponse(final HttpServletResponse httpServletResponse)

 	{

 		this.httpServletResponse = httpServletResponse;

 	}

	

 	public void addCookie(final Cookie cookie)

 	{

 		if (httpServletResponse != null)

 		{

 			httpServletResponse.addCookie(cookie);

 		}

 	}

	

 	public void clearCookie(final Cookie cookie)

 	{

 		if (httpServletResponse != null)

		{

			cookie.setMaxAge(0);

			cookie.setValue(null);

			addCookie(cookie);

		}

	}

	

	public void close()

	{

		// NOTE: Servlet container will close the response output stream

		// automatically, so we do nothing here.

	}

	

	public CharSequence encodeURL(CharSequence url)

	{

		if (httpServletResponse != null && url != null)

		{

			if (url.length() > 0 && url.charAt(0) == '?')

			{

				// there is a bug in apache tomcat 5.5 where tomcat doesn't put sessionid to url

				// when the URL starts with '?'. So we prepend the URL with ./ and remove it

				// afterwards (unless some container prepends session id before './' or mangles

				// the URL otherwise

				String encoded = httpServletResponse.encodeURL("./" + url.toString());

				if (encoded.startsWith("./"))

				{

					return encoded.substring(2);

				}

				else

				{

					return encoded;

				}

			}

			else

			{

				return httpServletResponse.encodeURL(url.toString());

			}

		}

		return url;

	}

	

	public final HttpServletResponse getHttpServletResponse()

	{

		return httpServletResponse;

	}

	

	public OutputStream getOutputStream()

	{

		try

		{

			return httpServletResponse.getOutputStream();

		}

		catch (IOException e)

		{

			throw new WicketRuntimeException("Error while getting output stream.", e);

		}

	}

	

	public final boolean isRedirect()

	{

		return redirect;

	}

	

	public void redirect(String url)

	{

		if (!redirect)

		{

			if (httpServletResponse != null)

			{

				// encode to make sure no caller forgot this

				url = httpServletResponse.encodeRedirectURL(url);

				try

				{

					if (httpServletResponse.isCommitted())

					{

						log.error("Unable to redirect to: " + url +

								", HTTP Response has already been committed.");

					}

					if (log.isDebugEnabled())

					{

						log.debug("Redirecting to " + url);

					}

					if (isAjax())

					{

						/*

						 * By reaching this point, make sure the HTTP response status code is set to

						 * 200, otherwise wicket-ajax.js will not process the Ajax-Location header

						 */

						httpServletResponse.addHeader("Ajax-Location", url);

						// safari chokes on empty response. but perhaps this is

						// not the best place?

						httpServletResponse.getWriter().write(" ");

					}

					else

					{

						httpServletResponse.sendRedirect(url);

					}

					redirect = true;

				}

				catch (IOException e)

				{

					log.warn("redirect to " + url + " failed: " + e.getMessage());

				}

			}

		}

		else

		{

			log.info("Already redirecting to an url current one ignored: " + url);

		}

	}

	

	public final void setContentType(final String mimeType)

	{

		if (httpServletResponse != null)

		{

			httpServletResponse.setContentType(mimeType);

		}

	}

	

	public void setContentLength(long length)

	{

		if (httpServletResponse != null)

		{

			httpServletResponse.setContentLength((int)length);

		}

	}

	

	public void setLastModifiedTime(Time time)

	{

		if (httpServletResponse != null)

		{

			if (time != null && time.getMilliseconds() != -1)

			{

				httpServletResponse.setDateHeader("Last-Modified", time.getMilliseconds());

			}

		}

	}

	

	public final void setLocale(final Locale locale)

	{

		if (httpServletResponse != null)

		{

			httpServletResponse.setLocale(locale);

		}

	}

	

	public void write(final CharSequence string)

	{

		if (string instanceof AppendingStringBuffer)

		{

			write((AppendingStringBuffer)string);

		}

		else if (string instanceof StringBuffer)

		{

			try

			{

				StringBuffer sb = (StringBuffer)string;

				char[] array = new char[sb.length()];

				sb.getChars(0, sb.length(), array, 0);

				httpServletResponse.getWriter().write(array, 0, array.length);

			}

			catch (IOException e)

			{

				throw new WicketRuntimeException("Error while writing to servlet output writer.", e);

			}

		}

		else

		{

			try

			{

				httpServletResponse.getWriter().write(string.toString());

			}

			catch (IOException e)

			{

				throw new WicketRuntimeException("Error while writing to servlet output writer.", e);

			}

		}

	}

	

	public void write(AppendingStringBuffer asb)

	{

		try

		{

			httpServletResponse.getWriter().write(asb.getValue(), 0, asb.length());

		}

		catch (IOException e)

		{

			throw new WicketRuntimeException("Error while writing to servlet output writer.", e);

		}

	}

	

	public void setDateHeader(String header, long date)

	{

		if (httpServletResponse != null)

		{

			httpServletResponse.setDateHeader(header, date);

		}

	}


	

	public void setHeader(String header, String value)

	{

		if (httpServletResponse != null)

		{

			httpServletResponse.setHeader(header, value);

		}

	}

	

	public void setAttachmentHeader(String filename)

	{

		setHeader("Content-Disposition", "attachment" +

				((!Strings.isEmpty(filename)) ? ("; filename=\"" + filename + "\"") : ""));

	}

	

	public boolean isAjax()

	{

		return ajax;

	}

	

	public void setAjax(boolean ajax)

	{

		this.ajax = ajax;

	}

}