ogb912/opensim
1
0
Fork 0
mirror of https://github.com/opensim/opensim.git synced 2026-08-11 20:05:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

here are further enhancements to the IHttpAgentHandler and to BaseHttpServer (from awebb)

Browse Source 
i've added the OSHttpStatusCodes enumeration of HTTP status codes, have adapted 
BaseHttpServer to use those.

then RestPlugin now has proper Failure handling returning proper HTTP status
codes. Regions/POSTHandler is work-in-progress.
This commit is contained in:
Dr Scofield
2008-05-22 12:00:01 +00:00
parent f22a63bd1c
commit bdc792d319
7 changed files with 392 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
OpenSim/ApplicationPlugins/Rest/Regions/GETHandler.cs
View File

@@ -67,18 +67,18 @@ namespace OpenSim.ApplicationPlugins.Rest.Regions
try
{
// param empty: regions list
if (String.IsNullOrEmpty(param)) return GetHandlerRegions();
if (String.IsNullOrEmpty(param)) return GetHandlerRegions(httpResponse);
// param not empty: specific region
return GetHandlerRegion(param);
return GetHandlerRegion(httpResponse, param);
}
catch (Exception e)
{
return Failure("GET", e);
return Failure(httpResponse, OSHttpStatusCode.ServerErrorInternalError, "GET", e);
}
}
public string GetHandlerRegions()
public string GetHandlerRegions(OSHttpResponse httpResponse)
{
XmlWriter.WriteStartElement(String.Empty, "regions", String.Empty);
foreach (Scene s in App.SceneManager.Scenes)
@@ -105,7 +105,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Regions
return XmlWriterResult;
}
public string GetHandlerRegion(string param)
public string GetHandlerRegion(OSHttpResponse httpResponse, string param)
{
// be resilient and don't get confused by a terminating '/'
param = param.TrimEnd(new char[]{'/'});
@@ -118,7 +118,8 @@ namespace OpenSim.ApplicationPlugins.Rest.Regions
Scene scene = null;
App.SceneManager.TryGetScene(regionID, out scene);
if (null == scene) return Failure("GET", "cannot find region");
if (null == scene) return Failure(httpResponse, OSHttpStatusCode.ClientErrorNotFound,
"GET", "cannot find region {0}", regionID.ToString());
RegionDetails details = new RegionDetails(scene.RegionInfo);
@@ -143,25 +144,27 @@ namespace OpenSim.ApplicationPlugins.Rest.Regions
switch (comps[1].ToLower())
{
case "terrain":
return RegionTerrain(scene);
return RegionTerrain(httpResponse, scene);
case "stats":
return RegionStats(scene);
return RegionStats(httpResponse, scene);
case "prims":
return RegionPrims(scene);
return RegionPrims(httpResponse, scene);
}
}
return Failure("GET", "too many parameters");
return Failure(httpResponse, OSHttpStatusCode.ClientErrorBadRequest,
"GET", "too many parameters {0}", param);
}
#endregion GET methods
protected string RegionTerrain(Scene scene)
protected string RegionTerrain(OSHttpResponse httpResponse, Scene scene)
{
return Failure("GET", "terrain not implemented");
return Failure(httpResponse, OSHttpStatusCode.ServerErrorNotImplemented,
"GET", "terrain not implemented");
}
protected string RegionStats(Scene scene)
protected string RegionStats(OSHttpResponse httpResponse, Scene scene)
{
int users = scene.GetAvatars().Count;
int objects = scene.Entities.Count - users;
@@ -182,9 +185,10 @@ namespace OpenSim.ApplicationPlugins.Rest.Regions
return XmlWriterResult;
}
protected string RegionPrims(Scene scene)
protected string RegionPrims(OSHttpResponse httpResponse, Scene scene)
{
return Failure("GET", "prims not implemented");
return Failure(httpResponse, OSHttpStatusCode.ServerErrorNotImplemented,
"GET", "prims not implemented");
}
}
}

101
OpenSim/ApplicationPlugins/Rest/Regions/POSTHandler.cs Normal file
View File

@@ -0,0 +1,101 @@
/*
* 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.Threading;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Net;
using System.Reflection;
using System.Text.RegularExpressions;
using System.Timers;
using System.Xml;
using System.Xml.Serialization;
using libsecondlife;
using Mono.Addins;
using Nwc.XmlRpc;
using Nini.Config;
using OpenSim.Framework;
using OpenSim.Framework.Console;
using OpenSim.Framework.Servers;
using OpenSim.Framework.Communications;
using OpenSim.Region.Environment.Scenes;
using OpenSim.ApplicationPlugins.Rest;
namespace OpenSim.ApplicationPlugins.Rest.Regions
{
public partial class RestRegionPlugin : RestPlugin
{
#region POST methods
public string PostHandler(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} POST path {1} param {2}", MsgID, path, param);
try
{
// param empty: new region post
if (!IsGod(httpRequest))
// XXX: this needs to be turned into a FailureUnauthorized(...)
return Failure(httpResponse, OSHttpStatusCode.ClientErrorUnauthorized,
"GET", "you are not god");
if (String.IsNullOrEmpty(param)) return CreateRegion(httpRequest, httpResponse);
return Failure(httpResponse, OSHttpStatusCode.ClientErrorNotFound,
"POST", "url {0} not supported", param);
}
catch (Exception e)
{
return Failure(httpResponse, OSHttpStatusCode.ServerErrorInternalError, "POST", e);
}
}
public string CreateRegion(OSHttpRequest request, OSHttpResponse response)
{
XmlWriter.WriteStartElement(String.Empty, "regions", String.Empty);
foreach (Scene s in App.SceneManager.Scenes)
{
XmlWriter.WriteStartElement(String.Empty, "uuid", String.Empty);
XmlWriter.WriteString(s.RegionInfo.RegionID.ToString());
XmlWriter.WriteEndElement();
}
XmlWriter.WriteEndElement();
return XmlWriterResult;
}
#endregion POST methods
}
}

1
OpenSim/ApplicationPlugins/Rest/Regions/RestRegionPlugin.cs
View File

@@ -92,6 +92,7 @@ namespace OpenSim.ApplicationPlugins.Rest.Regions
// add REST method handlers
AddRestStreamHandler("GET", "/regions/", GetHandler);
AddRestStreamHandler("POST", "/regions/", PostHandler);
}
catch (Exception e)
{

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

@@ -66,7 +66,7 @@ namespace OpenSim.ApplicationPlugins.Rest
private string _prefix; // URL prefix below
// which all REST URLs
// are living
private StringWriter _sw = null;
private StringWriter _sw = null;
private XmlTextWriter _xw = null;
private string _godkey;
@@ -240,7 +240,8 @@ namespace OpenSim.ApplicationPlugins.Rest
}
}
private List<RestStreamHandler> _handlers = new List<RestStreamHandler>();
private List<RestStreamHandler> _handlers = new List<RestStreamHandler>();
private Dictionary<string, IHttpAgentHandler> _agents = new Dictionary<string, IHttpAgentHandler>();
/// <summary>
/// Add a REST stream handler to the underlying HTTP server.
@@ -271,14 +272,38 @@ namespace OpenSim.ApplicationPlugins.Rest
/// </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>
/// <returns>false when the plugin is disabled or the agent
/// handler could not be added. Any generated exceptions are
/// allowed to drop through to the caller, i.e. ArgumentException.
/// </returns>
public bool AddAgentHandler(string agentName, IHttpAgentHandler handler)
{
if (!IsEnabled) return false;
_agents.Add(agentName, handler);
return _httpd.AddAgentHandler(agentName, handler);
}
/// <summary>
/// Remove a powerful Agent handler from the underlying HTTP
/// server.
/// </summary>
/// <param name="agentName">name of agent handler</param>
/// <param name="handler">agent handler method</param>
/// <returns>false when the plugin is disabled or the agent
/// handler could not be removed. Any generated exceptions are
/// allowed to drop through to the caller, i.e. KeyNotFound.
/// </returns>
public bool RemoveAgentHandler(string agentName, IHttpAgentHandler handler)
{
if (!IsEnabled) return false;
if(_agents[agentName] == handler)
{
_agents.Remove(agentName);
return _httpd.RemoveAgentHandler(agentName, handler);
}
return false;
}
/// <summary>
/// Check whether the HTTP request came from god; that is, is
/// the god_key as configured in the config section supplied
@@ -316,19 +341,30 @@ namespace OpenSim.ApplicationPlugins.Rest
_httpd.RemoveStreamHandler(h.HttpMethod, h.Path);
}
_handlers = null;
foreach (KeyValuePair<string,IHttpAgentHandler> h in _agents)
{
_httpd.RemoveAgentHandler(h.Key,h.Value);
}
_agents = null;
}
/// <summary>
/// Return a failure message.
/// </summary>
/// <param name="method">origin of the failure message</param>
/// <param name="message>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)
protected string Failure(OSHttpResponse response, OSHttpStatusCode status,
string method, string format, params string[] msg)
{
m_log.ErrorFormat("{0} {1} failed: {2}", MsgID, method, message);
return String.Format("<error>{0}</error>", message);
string m = String.Format(format, msg);
response.StatusCode = (int)status;
response.StatusDescription = m;
m_log.ErrorFormat("{0} {1} failed: {2}", MsgID, method, m);
return String.Format("<error>{0}</error>", m);
}
/// <summary>
@@ -338,8 +374,14 @@ namespace OpenSim.ApplicationPlugins.Rest
/// <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)
public string Failure(OSHttpResponse response, OSHttpStatusCode status,
string method, Exception e)
{
string m = String.Format("exception occurred: {0}", e.Message);
response.StatusCode = (int)status;
response.StatusDescription = m;
m_log.DebugFormat("{0} {1} failed: {2}", MsgID, method, e.ToString());
m_log.ErrorFormat("{0} {1} failed: {2}", MsgID, method, e.Message);