* Moved all capabilities code to the new library, OpenMetaverse.Http
* OpenMetaverse.Http contains a CAPS client + server, event queue client + server, SSL certificate generation (root CA, server certs, client certs), and client certificate authentication * HttpServer.dll and Mono.Security.dll are new dependencies for OpenMetaverse.Http.dll git-svn-id: http://libopenmetaverse.googlecode.com/svn/libopenmetaverse/trunk@2400 52acb1d6-8a22-11de-b505-999d5b087335
This commit is contained in:
John Hurliman
241
OpenMetaverse.Http/CapsClient.cs
Normal file
241
OpenMetaverse.Http/CapsClient.cs
Normal file
@@ -0,0 +1,241 @@
|
||||
/*
|
||||
* Copyright (c) 2007-2008, openmetaverse.org
|
||||
* All rights reserved.
|
||||
*
|
||||
* - 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.
|
||||
* - Neither the name of the openmetaverse.org 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 COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT OWNER OR 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.Net;
|
||||
using System.Security.Cryptography.X509Certificates;
|
||||
using OpenMetaverse.StructuredData;
|
||||
|
||||
namespace OpenMetaverse.Http
|
||||
{
|
||||
public class CapsClient
|
||||
{
|
||||
public delegate void ProgressCallback(CapsClient client, long bytesReceived, long bytesSent,
|
||||
long totalBytesToReceive, long totalBytesToSend);
|
||||
public delegate void CompleteCallback(CapsClient client, OSD result, Exception error);
|
||||
|
||||
public ProgressCallback OnProgress;
|
||||
public CompleteCallback OnComplete;
|
||||
|
||||
public IWebProxy Proxy;
|
||||
public object UserData;
|
||||
|
||||
protected CapsBase _Client;
|
||||
protected byte[] _PostData;
|
||||
protected string _ContentType;
|
||||
|
||||
public CapsClient(Uri capability)
|
||||
{
|
||||
Init(capability, null);
|
||||
}
|
||||
|
||||
public CapsClient(Uri capability, X509Certificate2 clientCert)
|
||||
{
|
||||
Init(capability, clientCert);
|
||||
}
|
||||
|
||||
void Init(Uri capability, X509Certificate2 clientCert)
|
||||
{
|
||||
_Client = new CapsBase(capability, clientCert);
|
||||
_Client.DownloadProgressChanged += new CapsBase.DownloadProgressChangedEventHandler(Client_DownloadProgressChanged);
|
||||
_Client.UploadProgressChanged += new CapsBase.UploadProgressChangedEventHandler(Client_UploadProgressChanged);
|
||||
_Client.UploadDataCompleted += new CapsBase.UploadDataCompletedEventHandler(Client_UploadDataCompleted);
|
||||
_Client.DownloadStringCompleted += new CapsBase.DownloadStringCompletedEventHandler(Client_DownloadStringCompleted);
|
||||
}
|
||||
|
||||
public void StartRequest()
|
||||
{
|
||||
StartRequest(null, null);
|
||||
}
|
||||
|
||||
public void StartRequest(OSD llsd)
|
||||
{
|
||||
byte[] postData = OSDParser.SerializeLLSDXmlBytes(llsd);
|
||||
StartRequest(postData, null);
|
||||
}
|
||||
|
||||
public void StartRequest(byte[] postData)
|
||||
{
|
||||
StartRequest(postData, null);
|
||||
}
|
||||
|
||||
public void StartRequest(byte[] postData, string contentType)
|
||||
{
|
||||
_PostData = postData;
|
||||
_ContentType = contentType;
|
||||
|
||||
if (_Client.IsBusy)
|
||||
_Client.CancelAsync();
|
||||
|
||||
_Client.Headers.Clear();
|
||||
|
||||
// Proxy
|
||||
if (Proxy != null)
|
||||
_Client.Proxy = Proxy;
|
||||
|
||||
// Content-Type
|
||||
if (!String.IsNullOrEmpty(contentType))
|
||||
_Client.Headers.Add(HttpRequestHeader.ContentType, contentType);
|
||||
else
|
||||
_Client.Headers.Add(HttpRequestHeader.ContentType, "application/xml");
|
||||
|
||||
if (postData == null)
|
||||
_Client.DownloadStringAsync(_Client.Location);
|
||||
else
|
||||
_Client.UploadDataAsync(_Client.Location, postData);
|
||||
}
|
||||
|
||||
public void Cancel()
|
||||
{
|
||||
if (_Client.IsBusy)
|
||||
_Client.CancelAsync();
|
||||
}
|
||||
|
||||
#region Callback Handlers
|
||||
|
||||
private void Client_DownloadProgressChanged(object sender, CapsBase.DownloadProgressChangedEventArgs e)
|
||||
{
|
||||
if (OnProgress != null)
|
||||
{
|
||||
try { OnProgress(this, e.BytesReceived, 0, e.TotalBytesToReceive, 0); }
|
||||
catch (Exception ex) { Logger.Log.Error(ex.Message, ex); }
|
||||
}
|
||||
}
|
||||
|
||||
private void Client_UploadProgressChanged(object sender, CapsBase.UploadProgressChangedEventArgs e)
|
||||
{
|
||||
if (OnProgress != null)
|
||||
{
|
||||
try { OnProgress(this, e.BytesReceived, e.BytesSent, e.TotalBytesToReceive, e.TotalBytesToSend); }
|
||||
catch (Exception ex) { Logger.Log.Error(ex.Message, ex); }
|
||||
}
|
||||
}
|
||||
|
||||
private void Client_UploadDataCompleted(object sender, CapsBase.UploadDataCompletedEventArgs e)
|
||||
{
|
||||
if (OnComplete != null && !e.Cancelled)
|
||||
{
|
||||
if (e.Error == null)
|
||||
{
|
||||
OSD result = OSDParser.DeserializeLLSDXml(e.Result);
|
||||
|
||||
try { OnComplete(this, result, e.Error); }
|
||||
catch (Exception ex) { Logger.Log.Error(ex.Message, ex); }
|
||||
}
|
||||
else
|
||||
{
|
||||
// Some error occurred, try to figure out what happened
|
||||
HttpStatusCode code = HttpStatusCode.OK;
|
||||
if (e.Error is WebException && ((WebException)e.Error).Response != null)
|
||||
code = ((HttpWebResponse)((WebException)e.Error).Response).StatusCode;
|
||||
|
||||
if (code == HttpStatusCode.BadGateway)
|
||||
{
|
||||
// This is not good (server) protocol design, but it's normal.
|
||||
// The CAPS server is a proxy that connects to a Squid
|
||||
// cache which will time out periodically. The CAPS server
|
||||
// interprets this as a generic error and returns a 502 to us
|
||||
// that we ignore
|
||||
StartRequest(_PostData, _ContentType);
|
||||
}
|
||||
else if (code != HttpStatusCode.OK)
|
||||
{
|
||||
// Status code was set to something unknown, this is a failure
|
||||
Logger.Log.DebugFormat("Caps error at {0}: {1}", _Client.Location, code);
|
||||
|
||||
try { OnComplete(this, null, e.Error); }
|
||||
catch (Exception ex) { Logger.Log.Error(ex.Message, ex); }
|
||||
}
|
||||
else
|
||||
{
|
||||
// Status code was not set, some other error occurred. This is a failure
|
||||
Logger.Log.DebugFormat("Caps error at {0}: {1}", _Client.Location, e.Error.Message);
|
||||
|
||||
try { OnComplete(this, null, e.Error); }
|
||||
catch (Exception ex) { Logger.Log.Error(ex.Message, ex); }
|
||||
}
|
||||
}
|
||||
}
|
||||
else if (e.Cancelled)
|
||||
{
|
||||
Logger.Log.Debug("Capability action at " + _Client.Location + " cancelled");
|
||||
}
|
||||
}
|
||||
|
||||
private void Client_DownloadStringCompleted(object sender, CapsBase.DownloadStringCompletedEventArgs e)
|
||||
{
|
||||
if (OnComplete != null && !e.Cancelled)
|
||||
{
|
||||
if (e.Error == null)
|
||||
{
|
||||
OSD result = OSDParser.DeserializeLLSDXml(e.Result);
|
||||
|
||||
try { OnComplete(this, result, e.Error); }
|
||||
catch (Exception ex) { Logger.Log.Error(ex.Message, ex); }
|
||||
}
|
||||
else
|
||||
{
|
||||
// Some error occurred, try to figure out what happened
|
||||
HttpStatusCode code = HttpStatusCode.OK;
|
||||
if (e.Error is WebException && ((WebException)e.Error).Response != null)
|
||||
code = ((HttpWebResponse)((WebException)e.Error).Response).StatusCode;
|
||||
|
||||
if (code == HttpStatusCode.BadGateway)
|
||||
{
|
||||
// This is not good (server) protocol design, but it's normal.
|
||||
// The CAPS server is a proxy that connects to a Squid
|
||||
// cache which will time out periodically. The CAPS server
|
||||
// interprets this as a generic error and returns a 502 to us
|
||||
// that we ignore
|
||||
StartRequest(_PostData, _ContentType);
|
||||
}
|
||||
else if (code != HttpStatusCode.OK)
|
||||
{
|
||||
// Status code was set to something unknown, this is a failure
|
||||
Logger.Log.DebugFormat("Caps error at {0}: {1}", _Client.Location, code);
|
||||
|
||||
try { OnComplete(this, null, e.Error); }
|
||||
catch (Exception ex) { Logger.Log.Error(ex.Message, ex); }
|
||||
}
|
||||
else
|
||||
{
|
||||
// Status code was not set, some other error occurred. This is a failure
|
||||
Logger.Log.DebugFormat("Caps error at {0}: {1}", _Client.Location, e.Error.Message);
|
||||
|
||||
try { OnComplete(this, null, e.Error); }
|
||||
catch (Exception ex) { Logger.Log.Error(ex.Message, ex); }
|
||||
}
|
||||
}
|
||||
}
|
||||
else if (e.Cancelled)
|
||||
{
|
||||
Logger.Log.Debug("Capability action at " + _Client.Location + " cancelled");
|
||||
}
|
||||
}
|
||||
|
||||
#endregion Callback Handlers
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user