/*
* Copyright (c) Contributors, http://opensimulator.org/
* See CONTRIBUTORS.TXT for a full list of copyright holders.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the OpenSim Project nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
using System;
using System.Collections;
using System.IO;
using System.Net;
using System.Text;
using HttpServer;
namespace OpenSim.Framework.Servers
{
///
/// OSHttpResponse is the OpenSim representation of an HTTP
/// response.
///
///
/// OSHttpResponse is currently dual "homed" in that it support
/// both the .NET HttpListenerResponse and the HttpServer
/// HttpResponse (similar to OSHttpRequest); this duality is only
/// temporary and the .NET usage will disappear once the switch to
/// HttpServer is completed.
///
public class OSHttpResponse
{
// property code below is a bit messy, will all resolve to
// harmony once we've completed the switch
///
/// Content type property.
///
///
/// Setting this property will also set IsContentTypeSet to
/// true.
///
public string ContentType
{
get
{
return HttpServer ? _httpResponse.ContentType : _contentType;
}
set
{
if (HttpServer)
{
_httpResponse.ContentType = value;
}
else
{
_contentType = value;
_contentTypeSet = true;
}
}
}
private string _contentType;
///
/// Boolean property indicating whether the content type
/// property actively has been set.
///
///
/// IsContentTypeSet will go away together with .NET base.
///
public bool IsContentTypeSet
{
get { return _contentTypeSet; }
}
private bool _contentTypeSet;
///
/// Length of the body content; 0 if there is no body.
///
public long ContentLength
{
get
{
return HttpServer ? _httpResponse.ContentLength : _contentLength;
}
set
{
if (HttpServer)
_httpResponse.ContentLength = value;
else
_contentLength = value;
}
}
private long _contentLength;
///
/// Aliases for ContentLength.
///
public long ContentLength64
{
get { return ContentLength; }
set { ContentLength = value; }
}
///
/// Encoding of the body content.
///
public Encoding ContentEncoding
{
get {
return HttpServer ? _httpResponse.Encoding : _contentEncoding;
}
set
{
if (HttpServer)
_httpResponse.Encoding = value;
else
_contentEncoding = value;
}
}
private Encoding _contentEncoding;
///
/// Headers of the response.
///
public WebHeaderCollection Headers
{
get
{
return HttpServer ? null : _headers;
}
}
private WebHeaderCollection _headers;
///
/// Get or set the keep alive property.
///
public bool KeepAlive
{
get
{
if (HttpServer)
return _httpResponse.Connection == ConnectionType.KeepAlive;
else
return _keepAlive;
}
set
{
if (HttpServer)
_httpResponse.Connection = ConnectionType.KeepAlive;
else
_keepAlive = value;
}
}
private bool _keepAlive;
///
/// Return the output stream feeding the body.
///
///
/// On its way out...
///
public Stream OutputStream
{
get
{
return HttpServer ? _httpResponse.Body : _outputStream;
}
}
private Stream _outputStream;
///
/// Return the output stream feeding the body.
///
public Stream Body
{
get
{
if (HttpServer)
return _httpResponse.Body;
throw new Exception("[OSHttpResponse] mixed .NET and HttpServer access");
}
}
///
/// Set a redirct location.
///
public string RedirectLocation
{
// get { return _redirectLocation; }
set
{
if (HttpServer)
_httpResponse.Redirect(value);
// else
// _redirectLocation = value;
}
}
// private string _redirectLocation;
///
/// Chunk transfers.
///
public bool SendChunked
{
get
{
return HttpServer ? _httpResponse.Chunked :_sendChunked;
}
set
{
if (HttpServer)
_httpResponse.Chunked = value;
else
_sendChunked = value;
}
}
private bool _sendChunked;
///
/// HTTP status code.
///
public int StatusCode
{
get
{
return HttpServer ? (int)_httpResponse.Status : _statusCode;
}
set
{
if (HttpServer)
_httpResponse.Status = (HttpStatusCode)value;
else
_statusCode = value;
}
}
private int _statusCode;
///
/// HTTP status description.
///
public string StatusDescription
{
get
{
return HttpServer ? _httpResponse.Reason : _statusDescription;
}
set
{
if (HttpServer)
_httpResponse.Reason = value;
else
_statusDescription = value;
}
}
private string _statusDescription;
private HttpResponse _httpResponse;
internal bool HttpServer
{
get { return null != _httpResponse; }
}
internal HttpResponse HttpResponse
{
get { return _httpResponse; }
}
public OSHttpResponse()
{
}
///
/// Instantiate an OSHttpResponse object based on an
/// underlying .NET HttpListenerResponse.
///
///
/// Almost deprecated; will go west to make once HttpServer
/// base takes over.
///
public OSHttpResponse(HttpListenerResponse resp)
{
_contentEncoding = resp.ContentEncoding;
_contentLength = resp.ContentLength64;
_contentType = resp.ContentType;
_headers = resp.Headers;
// _cookies = resp.Cookies;
_keepAlive = resp.KeepAlive;
_outputStream = resp.OutputStream;
// _redirectLocation = resp.RedirectLocation;
_sendChunked = resp.SendChunked;
_statusCode = resp.StatusCode;
_statusDescription = resp.StatusDescription;
_contentTypeSet = false;
// _resp = resp;
}
///
/// Instantiate an OSHttpResponse object from an OSHttpRequest
/// object.
/// Incoming OSHttpRequest to which we are
/// replying
public OSHttpResponse(OSHttpRequest req)
{
_httpResponse = new HttpResponse(req.HttpClientContext, req.HttpRequest);
}
///
/// Add a header field and content to the response.
///
/// string containing the header field
/// name
/// string containing the header field
/// value
public void AddHeader(string key, string value)
{
if (HttpServer)
_headers.Add(key, value);
else
_httpResponse.AddHeader(key, value);
}
///
/// Send the response back to the remote client
///
public void Send()
{
if (HttpServer)
{
_httpResponse.Body.Flush();
_httpResponse.Send();
}
else
{
OutputStream.Close();
}
}
}
}