From 7cf4bb5256be8e4b6a585e5128ccfc4b132bee04 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Mon, 22 Aug 2011 22:13:07 +0100
Subject: Add ISimulatorFeaturesModule so that other modules can register
features in addition to the hardcoded ones.
---
.../Linden/Caps/SimulatorFeaturesModule.cs | 122 +++++++++++++++------
.../Interfaces/ISimulatorFeaturesModule.cs | 43 ++++++++
2 files changed, 129 insertions(+), 36 deletions(-)
create mode 100644 OpenSim/Region/Framework/Interfaces/ISimulatorFeaturesModule.cs
diff --git a/OpenSim/Region/ClientStack/Linden/Caps/SimulatorFeaturesModule.cs b/OpenSim/Region/ClientStack/Linden/Caps/SimulatorFeaturesModule.cs
index 9f78948..b531c1f 100644
--- a/OpenSim/Region/ClientStack/Linden/Caps/SimulatorFeaturesModule.cs
+++ b/OpenSim/Region/ClientStack/Linden/Caps/SimulatorFeaturesModule.cs
@@ -43,21 +43,29 @@ using Caps = OpenSim.Framework.Capabilities.Caps;
namespace OpenSim.Region.ClientStack.Linden
{
///
- /// SimulatorFeatures capability. This is required for uploading Mesh.
+ /// SimulatorFeatures capability.
+ ///
+ ///
+ /// This is required for uploading Mesh.
/// Since is accepts an open-ended response, we also send more information
/// for viewers that care to interpret it.
///
/// NOTE: Part of this code was adapted from the Aurora project, specifically
/// the normal part of the response in the capability handler.
- ///
- ///
+ ///
[Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule")]
- public class SimulatorFeaturesModule : ISharedRegionModule
+ public class SimulatorFeaturesModule : ISharedRegionModule, ISimulatorFeaturesModule
{
private static readonly ILog m_log =
LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
private Scene m_scene;
+ ///
+ /// Simulator features
+ ///
+ private OSDMap m_features = new OSDMap();
+
private string m_MapImageServerURL = string.Empty;
private string m_SearchURL = string.Empty;
@@ -66,18 +74,20 @@ namespace OpenSim.Region.ClientStack.Linden
public void Initialise(IConfigSource source)
{
IConfig config = source.Configs["SimulatorFeatures"];
- if (config == null)
- return;
-
- m_MapImageServerURL = config.GetString("MapImageServerURI", string.Empty);
- if (m_MapImageServerURL != string.Empty)
+ if (config != null)
{
- m_MapImageServerURL = m_MapImageServerURL.Trim();
- if (!m_MapImageServerURL.EndsWith("/"))
- m_MapImageServerURL = m_MapImageServerURL + "/";
+ m_MapImageServerURL = config.GetString("MapImageServerURI", string.Empty);
+ if (m_MapImageServerURL != string.Empty)
+ {
+ m_MapImageServerURL = m_MapImageServerURL.Trim();
+ if (!m_MapImageServerURL.EndsWith("/"))
+ m_MapImageServerURL = m_MapImageServerURL + "/";
+ }
+
+ m_SearchURL = config.GetString("SearchServerURI", string.Empty);
}
- m_SearchURL = config.GetString("SearchServerURI", string.Empty);
+ AddDefaultFeatures();
}
public void AddRegion(Scene s)
@@ -110,43 +120,83 @@ namespace OpenSim.Region.ClientStack.Linden
#endregion
+ ///
+ /// Add default features
+ ///
+ ///
+ /// TODO: These should be added from other modules rather than hardcoded.
+ ///
+ private void AddDefaultFeatures()
+ {
+ lock (m_features)
+ {
+ m_features["MeshRezEnabled"] = true;
+ m_features["MeshUploadEnabled"] = true;
+ m_features["MeshXferEnabled"] = true;
+ m_features["PhysicsMaterialsEnabled"] = true;
+
+ OSDMap typesMap = new OSDMap();
+ typesMap["convex"] = true;
+ typesMap["none"] = true;
+ typesMap["prim"] = true;
+ m_features["PhysicsShapeTypes"] = typesMap;
+
+ // Extra information for viewers that want to use it
+ OSDMap gridServicesMap = new OSDMap();
+ if (m_MapImageServerURL != string.Empty)
+ gridServicesMap["map-server-url"] = m_MapImageServerURL;
+ if (m_SearchURL != string.Empty)
+ gridServicesMap["search"] = m_SearchURL;
+ m_features["GridServices"] = gridServicesMap;
+ }
+ }
+
public void RegisterCaps(UUID agentID, Caps caps)
{
- IRequestHandler reqHandler = new RestHTTPHandler("GET", "/CAPS/" + UUID.Random(), SimulatorFeatures);
+ IRequestHandler reqHandler
+ = new RestHTTPHandler("GET", "/CAPS/" + UUID.Random(), HandleSimulatorFeaturesRequest);
+
caps.RegisterHandler("SimulatorFeatures", reqHandler);
}
- private Hashtable SimulatorFeatures(Hashtable mDhttpMethod)
+ public void AddFeature(string name, OSD value)
+ {
+ lock (m_features)
+ m_features[name] = value;
+ }
+
+ public bool RemoveFeature(string name)
+ {
+ lock (m_features)
+ return m_features.Remove(name);
+ }
+
+ public bool TryGetFeature(string name, out OSD value)
+ {
+ lock (m_features)
+ return m_features.TryGetValue(name, out value);
+ }
+
+ public OSDMap GetFeatures()
+ {
+ lock (m_features)
+ return new OSDMap(m_features);
+ }
+
+ private Hashtable HandleSimulatorFeaturesRequest(Hashtable mDhttpMethod)
{
m_log.DebugFormat("[SIMULATOR FEATURES MODULE]: SimulatorFeatures request");
- OSDMap data = new OSDMap();
- data["MeshRezEnabled"] = true;
- data["MeshUploadEnabled"] = true;
- data["MeshXferEnabled"] = true;
- data["PhysicsMaterialsEnabled"] = true;
-
- OSDMap typesMap = new OSDMap();
- typesMap["convex"] = true;
- typesMap["none"] = true;
- typesMap["prim"] = true;
- data["PhysicsShapeTypes"] = typesMap;
-
- // Extra information for viewers that want to use it
- OSDMap gridServicesMap = new OSDMap();
- if (m_MapImageServerURL != string.Empty)
- gridServicesMap["map-server-url"] = m_MapImageServerURL;
- if (m_SearchURL != string.Empty)
- gridServicesMap["search"] = m_SearchURL;
- data["GridServices"] = gridServicesMap;
//Send back data
Hashtable responsedata = new Hashtable();
responsedata["int_response_code"] = 200;
responsedata["content_type"] = "text/plain";
responsedata["keepalive"] = false;
- responsedata["str_response_string"] = OSDParser.SerializeLLSDXmlString(data);
+
+ lock (m_features)
+ responsedata["str_response_string"] = OSDParser.SerializeLLSDXmlString(m_features);
+
return responsedata;
}
-
}
}
diff --git a/OpenSim/Region/Framework/Interfaces/ISimulatorFeaturesModule.cs b/OpenSim/Region/Framework/Interfaces/ISimulatorFeaturesModule.cs
new file mode 100644
index 0000000..8cef14e
--- /dev/null
+++ b/OpenSim/Region/Framework/Interfaces/ISimulatorFeaturesModule.cs
@@ -0,0 +1,43 @@
+/*
+ * 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 OpenSimulator 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 OpenMetaverse.StructuredData;
+
+namespace OpenSim.Region.Framework.Interfaces
+{
+ ///
+ /// Add remove or retrieve Simulator Features that will be given to a viewer via the SimulatorFeatures capability.
+ ///
+ public interface ISimulatorFeaturesModule
+ {
+ void AddFeature(string name, OSD value);
+ bool RemoveFeature(string name);
+ bool TryGetFeature(string name, out OSD value);
+ OSDMap GetFeatures();
+ }
+}
\ No newline at end of file
--
cgit v1.1