OpenSim
/
OpenSimMirror
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

i'm extending the RestStreamHandler.Handler(...) signature to actually 

provide OSHttpRequest and OSHttpResponse to our REST handler. 

also, this adds proper RestPlugin.IsGod() checking against the X-OpenSim-Godkey
HTTP request header.

last, i added XML doc comments to RestPlugin.cs
0.6.0-stable
Dr Scofield 2008-05-20 16:51:45 +00:00
parent 185eff8d0d
commit a53cea6b7e
11 changed files with 110 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
OpenSim/ApplicationPlugins/Rest/Regions/GETRestRegionPlugin.cs
View File

@ -54,8 +54,14 @@ namespace OpenSim.ApplicationPlugins.Rest.Regions
public partial class RestRegionPlugin : RestPlugin
{
#region GET methods
public string GetHandler(string request, string path, string param)
public string GetHandler(string request, string path, string param,
OSHttpRequest httpRequest, OSHttpResponse httpResponse)
{
// foreach (string h in httpRequest.Headers.AllKeys)
// foreach (string v in httpRequest.Headers.GetValues(h))
// m_log.DebugFormat("{0} IsGod: {1} -> {2}", MsgID, h, v);
MsgID = RequestID;
m_log.DebugFormat("{0} GET path {1} param {2}", MsgID, path, param);
try

58
OpenSim/ApplicationPlugins/Rest/RestPlugin.cs
View File

@ -240,9 +240,15 @@ namespace OpenSim.ApplicationPlugins.Rest
}
}
private List<RestStreamHandler> _handlers = new List<RestStreamHandler>();
/// <summary>
/// Add a REST stream handler to the underlying HTTP server.
/// </summary>
/// <param name="httpMethod">GET/PUT/POST/DELETE or
/// similar</param>
/// <param name="path">URL prefix</param>
/// <param name="method">RestMethod handler doing the actual work</param>
public virtual void AddRestStreamHandler(string httpMethod, string path, RestMethod method)
{
if (!IsEnabled) return;
@ -259,20 +265,50 @@ namespace OpenSim.ApplicationPlugins.Rest
m_log.DebugFormat("{0} Added REST handler {1} {2}", MsgID, httpMethod, path);
}
public bool AddAgentHandler(string agentname, IHttpAgentHandler handler)
/// <summary>
/// Add a powerful Agent handler to the underlying HTTP
/// server.
/// </summary>
/// <param name="agentName">name of agent handler</param>
/// <param name="handler">agent handler method</param>
/// <returns>true when the plugin is disabled or the agent
/// handler could not be added..</returns>
public bool AddAgentHandler(string agentName, IHttpAgentHandler handler)
{
if (!IsEnabled) return false;
return _httpd.AddAgentHandler(agentname, handler);
return _httpd.AddAgentHandler(agentName, handler);
}
/// <summary>
/// Check whether the HTTP request came from god; that is, is
/// the god_key as configured in the config section supplied
/// via X-OpenSim-Godkey?
/// </summary>
/// <param name="request">HTTP request header</param>
/// <returns>true when the HTTP request came from god.</returns>
protected bool IsGod(OSHttpRequest request)
{
string[] keys = request.Headers.GetValues("x-opensim-godkey");
string[] keys = request.Headers.GetValues("X-OpenSim-Godkey");
if (null == keys) return false;
// we take the last key supplied
return keys[keys.Length-1] == _godkey;
}
/// <summary>
/// Checks wether the X-OpenSim-Password value provided in the
/// HTTP header is indeed the password on file for the avatar
/// specified by the UUID
/// </summary>
protected bool IsVerifiedUser(OSHttpRequest request, LLUUID uuid)
{
// XXX under construction
return false;
}
/// <summary>
/// Clean up and remove all handlers that were added earlier.
/// </summary>
public virtual void Close()
{
foreach (RestStreamHandler h in _handlers)
@ -282,12 +318,26 @@ namespace OpenSim.ApplicationPlugins.Rest
_handlers = null;
}
/// <summary>
/// Return a failure message.
/// </summary>
/// <param name="method">origin of the failure message</param>
/// <param name="message>failure message</param>
/// <remarks>This should probably set a return code as
/// well. (?)</remarks>
protected string Failure(string method, string message)
{
m_log.ErrorFormat("{0} {1} failed: {2}", MsgID, method, message);
return String.Format("<error>{0}</error>", message);
}
/// <summary>
/// Return a failure message.
/// </summary>
/// <param name="method">origin of the failure message</param>
/// <param name="e">exception causing the failure message</param>
/// <remarks>This should probably set a return code as
/// well. (?)</remarks>
public string Failure(string method, Exception e)
{
m_log.DebugFormat("{0} {1} failed: {2}", MsgID, method, e.ToString());

3
OpenSim/Framework/Communications/CAPSService.cs
View File

@ -45,7 +45,8 @@ namespace OpenSim.Framework.Communications
m_server.AddStreamHandler(new RestStreamHandler("POST", path, restMethod));
}
public string CapsRequest(string request, string path, string param)
public string CapsRequest(string request, string path, string param,
OSHttpRequest httpRequest, OSHttpResponse httpResponse)
{
System.Console.WriteLine("new caps request " + request + " from path " + path);
return String.Empty;

13
OpenSim/Framework/Communications/Capabilities/Caps.cs
View File

@ -208,8 +208,11 @@ namespace OpenSim.Framework.Communications.Capabilities
/// <param name="request"></param>
/// <param name="path"></param>
/// <param name="param"></param>
/// <param name="httpRequest">HTTP request header object</param>
/// <param name="httpResponse">HTTP response header object</param>
/// <returns></returns>
public string CapsRequest(string request, string path, string param)
public string CapsRequest(string request, string path, string param,
OSHttpRequest httpRequest, OSHttpResponse httpResponse)
{
m_log.Debug("[CAPS]: Seed Caps Request in region: " + m_regionName);
//Console.WriteLine("caps request " + request);
@ -503,8 +506,11 @@ namespace OpenSim.Framework.Communications.Capabilities
/// <param name="request"></param>
/// <param name="path"></param>
/// <param name="param"></param>
/// <param name="httpRequest">HTTP request header object</param>
/// <param name="httpResponse">HTTP response header object</param>
/// <returns></returns>
public string ScriptTaskInventory(string request, string path, string param)
public string ScriptTaskInventory(string request, string path, string param,
OSHttpRequest httpRequest, OSHttpResponse httpResponse)
{
try
{
@ -558,7 +564,8 @@ namespace OpenSim.Framework.Communications.Capabilities
/// <param name="path"></param>
/// <param name="param"></param>
/// <returns></returns>
public string NoteCardAgentInventory(string request, string path, string param)
public string NoteCardAgentInventory(string request, string path, string param,
OSHttpRequest httpRequest, OSHttpResponse httpResponse)
{
m_log.Debug("[CAPS]: NoteCardAgentInventory Request in region: " + m_regionName);
//libsecondlife.StructuredData.LLSDMap hash = (libsecondlife.StructuredData.LLSDMap)libsecondlife.StructuredData.LLSDParser.DeserializeBinary(Helpers.StringToField(request));

3
OpenSim/Framework/Servers/RestMethod.cs
View File

@ -27,5 +27,6 @@
namespace OpenSim.Framework.Servers
{
public delegate string RestMethod(string request, string path, string param);
public delegate string RestMethod(string request, string path, string param,
OSHttpRequest httpRequest, OSHttpResponse httpResponse);
}

2
OpenSim/Framework/Servers/RestStreamHandler.cs
View File

@ -49,7 +49,7 @@ namespace OpenSim.Framework.Servers
streamReader.Close();
string param = GetParam(path);
string responseString = m_restMethod(requestBody, path, param);
string responseString = m_restMethod(requestBody, path, param, httpRequest, httpResponse);
return Encoding.UTF8.GetBytes(responseString);
}

24
OpenSim/Grid/GridServer/GridManager.cs
View File

@ -877,10 +877,13 @@ namespace OpenSim.Grid.GridServer
/// <param name="request"></param>
/// <param name="path"></param>
/// <param name="param"></param>
/// <param name="httpRequest">HTTP request header object</param>
/// <param name="httpResponse">HTTP response header object</param>
/// <returns></returns>
public string RestGetRegionMethod(string request, string path, string param)
public string RestGetRegionMethod(string request, string path, string param,
OSHttpRequest httpRequest, OSHttpResponse httpResponse)
{
return RestGetSimMethod(String.Empty, "/sims/", param);
return RestGetSimMethod(String.Empty, "/sims/", param, httpRequest, httpResponse);
}
/// <summary>
@ -889,10 +892,13 @@ namespace OpenSim.Grid.GridServer
/// <param name="request"></param>
/// <param name="path"></param>
/// <param name="param"></param>
/// <param name="httpRequest">HTTP request header object</param>
/// <param name="httpResponse">HTTP response header object</param>
/// <returns></returns>
public string RestSetRegionMethod(string request, string path, string param)
public string RestSetRegionMethod(string request, string path, string param,
OSHttpRequest httpRequest, OSHttpResponse httpResponse)
{
return RestSetSimMethod(String.Empty, "/sims/", param);
return RestSetSimMethod(String.Empty, "/sims/", param, httpRequest, httpResponse);
}
/// <summary>
@ -901,8 +907,11 @@ namespace OpenSim.Grid.GridServer
/// <param name="request"></param>
/// <param name="path"></param>
/// <param name="param">A string representing the sim's UUID</param>
/// <param name="httpRequest">HTTP request header object</param>
/// <param name="httpResponse">HTTP response header object</param>
/// <returns>Information about the sim in XML</returns>
public string RestGetSimMethod(string request, string path, string param)
public string RestGetSimMethod(string request, string path, string param,
OSHttpRequest httpRequest, OSHttpResponse httpResponse)
{
string respstring = String.Empty;
@ -946,8 +955,11 @@ namespace OpenSim.Grid.GridServer
/// <param name="request"></param>
/// <param name="path"></param>
/// <param name="param"></param>
/// <param name="httpRequest">HTTP request header object</param>
/// <param name="httpResponse">HTTP response header object</param>
/// <returns>"OK" or an error</returns>
public string RestSetSimMethod(string request, string path, string param)
public string RestSetSimMethod(string request, string path, string param,
OSHttpRequest httpRequest, OSHttpResponse httpResponse)
{
Console.WriteLine("Processing region update via REST method");
RegionProfileData theSim;

6
OpenSim/Grid/UserServer/UserManager.cs
View File

@ -35,6 +35,7 @@ using log4net;
using Nwc.XmlRpc;
using OpenSim.Framework;
using OpenSim.Framework.Communications;
using OpenSim.Framework.Servers;
namespace OpenSim.Grid.UserServer
{
@ -53,8 +54,11 @@ namespace OpenSim.Grid.UserServer
/// <param name="request">The request</param>
/// <param name="path">The path (eg /bork/narf/test)</param>
/// <param name="param">Parameters sent</param>
/// <param name="httpRequest">HTTP request header object</param>
/// <param name="httpResponse">HTTP response header object</param>
/// <returns>Success "OK" else error</returns>
public string RestDeleteUserSessionMethod(string request, string path, string param)
public string RestDeleteUserSessionMethod(string request, string path, string param,
OSHttpRequest httpRequest, OSHttpResponse httpResponse)
{
// TODO! Important!

3
OpenSim/Region/DataSnapshot/DataRequestHandler.cs
View File

@ -72,7 +72,8 @@ namespace OpenSim.Region.DataSnapshot
new RestStreamHandler("POST", capsBase + m_discoveryPath, OnDiscoveryAttempt));
}
public string OnDiscoveryAttempt(string request, string path, string param)
public string OnDiscoveryAttempt(string request, string path, string param,
OSHttpRequest httpRequest, OSHttpResponse httpResponse)
{
//Very static for now, flexible enough to add new formats
LLSDDiscoveryResponse llsd_response = new LLSDDiscoveryResponse();

6
OpenSim/Region/Environment/Modules/Avatar/Voice/AsterixVoice/AsteriskVoiceModule.cs
View File

@ -131,14 +131,16 @@ namespace OpenSim.Region.Environment.Modules.Avatar.Voice.AsterixVoice
string capsBase = "/CAPS/" + caps.CapsObjectPath;
caps.RegisterHandler("ParcelVoiceInfoRequest",
new RestStreamHandler("POST", capsBase + m_parcelVoiceInfoRequestPath,
delegate(string request, string path, string param)
delegate(string request, string path, string param,
OSHttpRequest httpRequest, OSHttpResponse httpResponse)
{
return ParcelVoiceInfoRequest(request, path, param,
agentID, caps);
}));
caps.RegisterHandler("ProvisionVoiceAccountRequest",
new RestStreamHandler("POST", capsBase + m_provisionVoiceAccountRequestPath,
delegate(string request, string path, string param)
delegate(string request, string path, string param,
OSHttpRequest httpRequest, OSHttpResponse httpResponse)
{
return ProvisionVoiceAccountRequest(request, path, param,
agentID, caps);

6
OpenSim/Region/Environment/Modules/Avatar/Voice/SIPVoice/SIPVoiceModule.cs
View File

@ -104,14 +104,16 @@ namespace OpenSim.Region.Environment.Modules.Avatar.Voice.SIPVoice
string capsBase = "/CAPS/" + caps.CapsObjectPath;
caps.RegisterHandler("ParcelVoiceInfoRequest",
new RestStreamHandler("POST", capsBase + m_parcelVoiceInfoRequestPath,
delegate(string request, string path, string param)
delegate(string request, string path, string param,
OSHttpRequest httpRequest, OSHttpResponse httpResponse)
{
return ParcelVoiceInfoRequest(request, path, param,
agentID, caps);
}));
caps.RegisterHandler("ProvisionVoiceAccountRequest",
new RestStreamHandler("POST", capsBase + m_provisionVoiceAccountRequestPath,
delegate(string request, string path, string param)
delegate(string request, string path, string param,
OSHttpRequest httpRequest, OSHttpResponse httpResponse)
{
return ProvisionVoiceAccountRequest(request, path, param,
agentID, caps);