From ca0336d8349382ddb46df4c7e7f6377c64151f25 Mon Sep 17 00:00:00 2001
From: Oren Hurvitz
Date: Thu, 5 Dec 2013 14:18:59 +0200
Subject: Renamed MaterialsDemoModule to MaterialsModule
---
.../Materials/MaterialsDemoModule.cs | 664 ---------------------
.../OptionalModules/Materials/MaterialsModule.cs | 664 +++++++++++++++++++++
2 files changed, 664 insertions(+), 664 deletions(-)
delete mode 100644 OpenSim/Region/OptionalModules/Materials/MaterialsDemoModule.cs
create mode 100644 OpenSim/Region/OptionalModules/Materials/MaterialsModule.cs
(limited to 'OpenSim/Region/OptionalModules')
diff --git a/OpenSim/Region/OptionalModules/Materials/MaterialsDemoModule.cs b/OpenSim/Region/OptionalModules/Materials/MaterialsDemoModule.cs
deleted file mode 100644
index 44b1a4a..0000000
--- a/OpenSim/Region/OptionalModules/Materials/MaterialsDemoModule.cs
+++ /dev/null
@@ -1,664 +0,0 @@
-/*
- * 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 System.Collections.Generic;
-using System.IO;
-using System.Reflection;
-using System.Security.Cryptography; // for computing md5 hash
-using log4net;
-using Mono.Addins;
-using Nini.Config;
-
-using OpenMetaverse;
-using OpenMetaverse.StructuredData;
-
-using OpenSim.Framework;
-using OpenSim.Framework.Servers;
-using OpenSim.Framework.Servers.HttpServer;
-using OpenSim.Region.Framework.Interfaces;
-using OpenSim.Region.Framework.Scenes;
-
-using Ionic.Zlib;
-
-// You will need to uncomment these lines if you are adding a region module to some other assembly which does not already
-// specify its assembly. Otherwise, the region modules in the assembly will not be picked up when OpenSimulator scans
-// the available DLLs
-//[assembly: Addin("MaterialsDemoModule", "1.0")]
-//[assembly: AddinDependency("OpenSim", "0.5")]
-
-namespace OpenSim.Region.OptionalModules.MaterialsDemoModule
-{
- ///
- ///
- // # # ## ##### # # # # # ####
- // # # # # # # ## # # ## # # #
- // # # # # # # # # # # # # # #
- // # ## # ###### ##### # # # # # # # # ###
- // ## ## # # # # # ## # # ## # #
- // # # # # # # # # # # # ####
- //
- // THIS MODULE IS FOR EXPERIMENTAL USE ONLY AND MAY CAUSE REGION OR ASSET CORRUPTION!
- //
- ////////////// WARNING //////////////////////////////////////////////////////////////////
- /// This is an *Experimental* module for developing support for materials-capable viewers
- /// This module should NOT be used in a production environment! It may cause data corruption and
- /// viewer crashes. It should be only used to evaluate implementations of materials.
- ///
- /// Materials are persisted via SceneObjectPart.dynattrs. This is a relatively new feature
- /// of OpenSimulator and is not field proven at the time this module was written. Persistence
- /// may fail or become corrupt and this could cause viewer crashes due to erroneous materials
- /// data being sent to viewers. Materials descriptions might survive IAR, OAR, or other means
- /// of archiving however the texture resources used by these materials probably will not as they
- /// may not be adequately referenced to ensure proper archiving.
- ///
- ///
- ///
- /// To enable this module, add this string at the bottom of OpenSim.ini:
- /// [MaterialsDemoModule]
- ///
- ///
- ///
-
- [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "MaterialsDemoModule")]
- public class MaterialsDemoModule : INonSharedRegionModule
- {
- private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
-
- public string Name { get { return "MaterialsDemoModule"; } }
-
- public Type ReplaceableInterface { get { return null; } }
-
- private Scene m_scene = null;
- private bool m_enabled = false;
-
- public Dictionary m_knownMaterials = new Dictionary();
-
- public void Initialise(IConfigSource source)
- {
- m_enabled = (source.Configs["MaterialsDemoModule"] != null);
- if (!m_enabled)
- return;
-
- m_log.DebugFormat("[MaterialsDemoModule]: Initialized");
- }
-
- public void Close()
- {
- if (!m_enabled)
- return;
-
- //m_log.DebugFormat("[MaterialsDemoModule]: CLOSED MODULE");
- }
-
- public void AddRegion(Scene scene)
- {
- if (!m_enabled)
- return;
-
- //m_log.DebugFormat("[MaterialsDemoModule]: REGION {0} ADDED", scene.RegionInfo.RegionName);
-
- m_scene = scene;
- m_scene.EventManager.OnRegisterCaps += OnRegisterCaps;
- m_scene.EventManager.OnObjectAddedToScene += EventManager_OnObjectAddedToScene;
-// m_scene.EventManager.OnGatherUuids += GatherMaterialsUuids;
- }
-
- void EventManager_OnObjectAddedToScene(SceneObjectGroup obj)
- {
- foreach (var part in obj.Parts)
- if (part != null)
- GetStoredMaterialsForPart(part);
- }
-
- void OnRegisterCaps(OpenMetaverse.UUID agentID, OpenSim.Framework.Capabilities.Caps caps)
- {
- string capsBase = "/CAPS/" + caps.CapsObjectPath;
-
- IRequestHandler renderMaterialsPostHandler
- = new RestStreamHandler("POST", capsBase + "/", RenderMaterialsPostCap, "RenderMaterials", null);
- caps.RegisterHandler("RenderMaterials", renderMaterialsPostHandler);
-
- // OpenSimulator CAPs infrastructure seems to be somewhat hostile towards any CAP that requires both GET
- // and POST handlers, (at least at the time this was originally written), so we first set up a POST
- // handler normally and then add a GET handler via MainServer
-
- IRequestHandler renderMaterialsGetHandler
- = new RestStreamHandler("GET", capsBase + "/", RenderMaterialsGetCap, "RenderMaterials", null);
- MainServer.Instance.AddStreamHandler(renderMaterialsGetHandler);
-
- // materials viewer seems to use either POST or PUT, so assign POST handler for PUT as well
- IRequestHandler renderMaterialsPutHandler
- = new RestStreamHandler("PUT", capsBase + "/", RenderMaterialsPostCap, "RenderMaterials", null);
- MainServer.Instance.AddStreamHandler(renderMaterialsPutHandler);
- }
-
- public void RemoveRegion(Scene scene)
- {
- if (!m_enabled)
- return;
-
- m_scene.EventManager.OnRegisterCaps -= OnRegisterCaps;
- m_scene.EventManager.OnObjectAddedToScene -= EventManager_OnObjectAddedToScene;
-// m_scene.EventManager.OnGatherUuids -= GatherMaterialsUuids;
-
- //m_log.DebugFormat("[MaterialsDemoModule]: REGION {0} REMOVED", scene.RegionInfo.RegionName);
- }
-
- public void RegionLoaded(Scene scene)
- {
- }
-
- OSDMap GetMaterial(UUID id)
- {
- OSDMap map = null;
- lock (m_knownMaterials)
- {
- if (m_knownMaterials.ContainsKey(id))
- {
- map = new OSDMap();
- map["ID"] = OSD.FromBinary(id.GetBytes());
- map["Material"] = m_knownMaterials[id];
- }
- }
- return map;
- }
-
- void GetStoredMaterialsForPart(SceneObjectPart part)
- {
- OSD OSMaterials = null;
- OSDArray matsArr = null;
-
- if (part.DynAttrs == null)
- {
- //m_log.Warn("[MaterialsDemoModule]: NULL DYNATTRS :( ");
- return;
- }
-
- lock (part.DynAttrs)
- {
- if (part.DynAttrs.ContainsStore("OpenSim", "Materials"))
- {
- OSDMap materialsStore = part.DynAttrs.GetStore("OpenSim", "Materials");
-
- if (materialsStore == null)
- return;
-
- materialsStore.TryGetValue("Materials", out OSMaterials);
- }
-
- if (OSMaterials != null && OSMaterials is OSDArray)
- matsArr = OSMaterials as OSDArray;
- else
- return;
- }
-
- //m_log.Info("[MaterialsDemoModule]: OSMaterials: " + OSDParser.SerializeJsonString(OSMaterials));
-
- if (matsArr == null)
- {
- //m_log.Info("[MaterialsDemoModule]: matsArr is null :( ");
- return;
- }
-
- foreach (OSD elemOsd in matsArr)
- {
- if (elemOsd != null && elemOsd is OSDMap)
- {
- OSDMap matMap = elemOsd as OSDMap;
- if (matMap.ContainsKey("ID") && matMap.ContainsKey("Material"))
- {
- try
- {
- lock (m_knownMaterials)
- m_knownMaterials[matMap["ID"].AsUUID()] = (OSDMap)matMap["Material"];
- }
- catch (Exception e)
- {
- m_log.Warn("[MaterialsDemoModule]: exception decoding persisted material ", e);
- }
- }
- }
- }
- }
-
- void StoreMaterialsForPart(SceneObjectPart part)
- {
- try
- {
- if (part == null || part.Shape == null)
- return;
-
- Dictionary mats = new Dictionary();
-
- Primitive.TextureEntry te = part.Shape.Textures;
-
- if (te.DefaultTexture != null)
- {
- lock (m_knownMaterials)
- {
- if (m_knownMaterials.ContainsKey(te.DefaultTexture.MaterialID))
- mats[te.DefaultTexture.MaterialID] = m_knownMaterials[te.DefaultTexture.MaterialID];
- }
- }
-
- if (te.FaceTextures != null)
- {
- foreach (var face in te.FaceTextures)
- {
- if (face != null)
- {
- lock (m_knownMaterials)
- {
- if (m_knownMaterials.ContainsKey(face.MaterialID))
- mats[face.MaterialID] = m_knownMaterials[face.MaterialID];
- }
- }
- }
- }
- if (mats.Count == 0)
- return;
-
- OSDArray matsArr = new OSDArray();
- foreach (KeyValuePair kvp in mats)
- {
- OSDMap matOsd = new OSDMap();
- matOsd["ID"] = OSD.FromUUID(kvp.Key);
- matOsd["Material"] = kvp.Value;
- matsArr.Add(matOsd);
- }
-
- OSDMap OSMaterials = new OSDMap();
- OSMaterials["Materials"] = matsArr;
-
- lock (part.DynAttrs)
- part.DynAttrs.SetStore("OpenSim", "Materials", OSMaterials);
- }
- catch (Exception e)
- {
- m_log.Warn("[MaterialsDemoModule]: exception in StoreMaterialsForPart() ", e);
- }
- }
-
- public string RenderMaterialsPostCap(string request, string path,
- string param, IOSHttpRequest httpRequest,
- IOSHttpResponse httpResponse)
- {
- //m_log.Debug("[MaterialsDemoModule]: POST cap handler");
-
- OSDMap req = (OSDMap)OSDParser.DeserializeLLSDXml(request);
- OSDMap resp = new OSDMap();
-
- OSDMap materialsFromViewer = null;
-
- OSDArray respArr = new OSDArray();
-
- if (req.ContainsKey("Zipped"))
- {
- OSD osd = null;
-
- byte[] inBytes = req["Zipped"].AsBinary();
-
- try
- {
- osd = ZDecompressBytesToOsd(inBytes);
-
- if (osd != null)
- {
- if (osd is OSDArray) // assume array of MaterialIDs designating requested material entries
- {
- foreach (OSD elem in (OSDArray)osd)
- {
-
- try
- {
- UUID id = new UUID(elem.AsBinary(), 0);
-
- lock (m_knownMaterials)
- {
- if (m_knownMaterials.ContainsKey(id))
- {
- //m_log.Info("[MaterialsDemoModule]: request for known material ID: " + id.ToString());
- OSDMap matMap = new OSDMap();
- matMap["ID"] = OSD.FromBinary(id.GetBytes());
-
- matMap["Material"] = m_knownMaterials[id];
- respArr.Add(matMap);
- }
- else
- m_log.Info("[MaterialsDemoModule]: request for UNKNOWN material ID: " + id.ToString());
- }
- }
- catch (Exception e)
- {
- // report something here?
- continue;
- }
- }
- }
- else if (osd is OSDMap) // reqest to assign a material
- {
- materialsFromViewer = osd as OSDMap;
-
- if (materialsFromViewer.ContainsKey("FullMaterialsPerFace"))
- {
- OSD matsOsd = materialsFromViewer["FullMaterialsPerFace"];
- if (matsOsd is OSDArray)
- {
- OSDArray matsArr = matsOsd as OSDArray;
-
- try
- {
- foreach (OSDMap matsMap in matsArr)
- {
- //m_log.Debug("[MaterialsDemoModule]: processing matsMap: " + OSDParser.SerializeJsonString(matsMap));
-
- uint primLocalID = 0;
- try { primLocalID = matsMap["ID"].AsUInteger(); }
- catch (Exception e) { m_log.Warn("[MaterialsDemoModule]: cannot decode \"ID\" from matsMap: " + e.Message); }
- //m_log.Debug("[MaterialsDemoModule]: primLocalID: " + primLocalID.ToString());
-
- OSDMap mat = null;
- try { mat = matsMap["Material"] as OSDMap; }
- catch (Exception e) { m_log.Warn("[MaterialsDemoModule]: cannot decode \"Material\" from matsMap: " + e.Message); }
- //m_log.Debug("[MaterialsDemoModule]: mat: " + OSDParser.SerializeJsonString(mat));
-
- UUID id;
- if (mat == null)
- {
- id = UUID.Zero;
- }
- else
- {
- id = HashOsd(mat);
- lock (m_knownMaterials)
- m_knownMaterials[id] = mat;
- }
-
- var sop = m_scene.GetSceneObjectPart(primLocalID);
- if (sop == null)
- m_log.Debug("[MaterialsDemoModule]: null SOP for localId: " + primLocalID.ToString());
- else
- {
- var te = new Primitive.TextureEntry(sop.Shape.TextureEntry, 0, sop.Shape.TextureEntry.Length);
-
- if (te == null)
- {
- m_log.Debug("[MaterialsDemoModule]: null TextureEntry for localId: " + primLocalID.ToString());
- }
- else
- {
- int face = -1;
-
- if (matsMap.ContainsKey("Face"))
- {
- face = matsMap["Face"].AsInteger();
- if (te.FaceTextures == null) // && face == 0)
- {
- if (te.DefaultTexture == null)
- m_log.Debug("[MaterialsDemoModule]: te.DefaultTexture is null");
- else
- te.DefaultTexture.MaterialID = id;
- }
- else
- {
- if (te.FaceTextures.Length >= face - 1)
- {
- if (te.FaceTextures[face] == null)
- te.DefaultTexture.MaterialID = id;
- else
- te.FaceTextures[face].MaterialID = id;
- }
- }
- }
- else
- {
- if (te.DefaultTexture != null)
- te.DefaultTexture.MaterialID = id;
- }
-
- //m_log.DebugFormat("[MaterialsDemoModule]: in \"{0}\", setting material ID for face {1} to {2}", sop.Name, face, id);
-
- //we cant use sop.UpdateTextureEntry(te); because it filters so do it manually
-
- if (sop.ParentGroup != null)
- {
- sop.Shape.TextureEntry = te.GetBytes();
- sop.TriggerScriptChangedEvent(Changed.TEXTURE);
- sop.UpdateFlag = UpdateRequired.FULL;
- sop.ParentGroup.HasGroupChanged = true;
-
- sop.ScheduleFullUpdate();
-
- StoreMaterialsForPart(sop);
- }
- }
- }
- }
- }
- catch (Exception e)
- {
- m_log.Warn("[MaterialsDemoModule]: exception processing received material ", e);
- }
- }
- }
- }
- }
-
- }
- catch (Exception e)
- {
- m_log.Warn("[MaterialsDemoModule]: exception decoding zipped CAP payload ", e);
- //return "";
- }
- //m_log.Debug("[MaterialsDemoModule]: knownMaterials.Count: " + m_knownMaterials.Count.ToString());
- }
-
-
- resp["Zipped"] = ZCompressOSD(respArr, false);
- string response = OSDParser.SerializeLLSDXmlString(resp);
-
- //m_log.Debug("[MaterialsDemoModule]: cap request: " + request);
- //m_log.Debug("[MaterialsDemoModule]: cap request (zipped portion): " + ZippedOsdBytesToString(req["Zipped"].AsBinary()));
- //m_log.Debug("[MaterialsDemoModule]: cap response: " + response);
- return response;
- }
-
-
- public string RenderMaterialsGetCap(string request, string path,
- string param, IOSHttpRequest httpRequest,
- IOSHttpResponse httpResponse)
- {
- //m_log.Debug("[MaterialsDemoModule]: GET cap handler");
-
- OSDMap resp = new OSDMap();
- int matsCount = 0;
- OSDArray allOsd = new OSDArray();
-
- lock (m_knownMaterials)
- {
- foreach (KeyValuePair kvp in m_knownMaterials)
- {
- OSDMap matMap = new OSDMap();
-
- matMap["ID"] = OSD.FromBinary(kvp.Key.GetBytes());
- matMap["Material"] = kvp.Value;
- allOsd.Add(matMap);
- matsCount++;
- }
- }
-
- resp["Zipped"] = ZCompressOSD(allOsd, false);
- //m_log.Debug("[MaterialsDemoModule]: matsCount: " + matsCount.ToString());
-
- return OSDParser.SerializeLLSDXmlString(resp);
- }
-
- static string ZippedOsdBytesToString(byte[] bytes)
- {
- try
- {
- return OSDParser.SerializeJsonString(ZDecompressBytesToOsd(bytes));
- }
- catch (Exception e)
- {
- return "ZippedOsdBytesToString caught an exception: " + e.ToString();
- }
- }
-
- ///
- /// computes a UUID by hashing a OSD object
- ///
- ///
- ///
- private static UUID HashOsd(OSD osd)
- {
- using (var md5 = MD5.Create())
- using (MemoryStream ms = new MemoryStream(OSDParser.SerializeLLSDBinary(osd, false)))
- return new UUID(md5.ComputeHash(ms), 0);
- }
-
- public static OSD ZCompressOSD(OSD inOsd, bool useHeader)
- {
- OSD osd = null;
-
- using (MemoryStream msSinkCompressed = new MemoryStream())
- {
- using (Ionic.Zlib.ZlibStream zOut = new Ionic.Zlib.ZlibStream(msSinkCompressed,
- Ionic.Zlib.CompressionMode.Compress, CompressionLevel.BestCompression, true))
- {
- CopyStream(new MemoryStream(OSDParser.SerializeLLSDBinary(inOsd, useHeader)), zOut);
- zOut.Close();
- }
-
- msSinkCompressed.Seek(0L, SeekOrigin.Begin);
- osd = OSD.FromBinary( msSinkCompressed.ToArray());
- }
-
- return osd;
- }
-
-
- public static OSD ZDecompressBytesToOsd(byte[] input)
- {
- OSD osd = null;
-
- using (MemoryStream msSinkUnCompressed = new MemoryStream())
- {
- using (Ionic.Zlib.ZlibStream zOut = new Ionic.Zlib.ZlibStream(msSinkUnCompressed, CompressionMode.Decompress, true))
- {
- CopyStream(new MemoryStream(input), zOut);
- zOut.Close();
- }
- msSinkUnCompressed.Seek(0L, SeekOrigin.Begin);
- osd = OSDParser.DeserializeLLSDBinary(msSinkUnCompressed.ToArray());
- }
-
- return osd;
- }
-
- static void CopyStream(System.IO.Stream input, System.IO.Stream output)
- {
- byte[] buffer = new byte[2048];
- int len;
- while ((len = input.Read(buffer, 0, 2048)) > 0)
- {
- output.Write(buffer, 0, len);
- }
-
- output.Flush();
- }
-
- // FIXME: This code is currently still in UuidGatherer since we cannot use Scene.EventManager as some
- // calls to the gatherer are done for objects with no scene.
-// ///
-// /// Gather all of the texture asset UUIDs used to reference "Materials" such as normal and specular maps
-// ///
-// ///
-// ///
-// private void GatherMaterialsUuids(SceneObjectPart part, IDictionary assetUuids)
-// {
-// // scan thru the dynAttrs map of this part for any textures used as materials
-// OSD osdMaterials = null;
-//
-// lock (part.DynAttrs)
-// {
-// if (part.DynAttrs.ContainsStore("OpenSim", "Materials"))
-// {
-// OSDMap materialsStore = part.DynAttrs.GetStore("OpenSim", "Materials");
-// if (materialsStore == null)
-// return;
-//
-// materialsStore.TryGetValue("Materials", out osdMaterials);
-// }
-//
-// if (osdMaterials != null)
-// {
-// //m_log.Info("[UUID Gatherer]: found Materials: " + OSDParser.SerializeJsonString(osd));
-//
-// if (osdMaterials is OSDArray)
-// {
-// OSDArray matsArr = osdMaterials as OSDArray;
-// foreach (OSDMap matMap in matsArr)
-// {
-// try
-// {
-// if (matMap.ContainsKey("Material"))
-// {
-// OSDMap mat = matMap["Material"] as OSDMap;
-// if (mat.ContainsKey("NormMap"))
-// {
-// UUID normalMapId = mat["NormMap"].AsUUID();
-// if (normalMapId != UUID.Zero)
-// {
-// assetUuids[normalMapId] = AssetType.Texture;
-// //m_log.Info("[UUID Gatherer]: found normal map ID: " + normalMapId.ToString());
-// }
-// }
-// if (mat.ContainsKey("SpecMap"))
-// {
-// UUID specularMapId = mat["SpecMap"].AsUUID();
-// if (specularMapId != UUID.Zero)
-// {
-// assetUuids[specularMapId] = AssetType.Texture;
-// //m_log.Info("[UUID Gatherer]: found specular map ID: " + specularMapId.ToString());
-// }
-// }
-// }
-//
-// }
-// catch (Exception e)
-// {
-// m_log.Warn("[MaterialsDemoModule]: exception getting materials: " + e.Message);
-// }
-// }
-// }
-// }
-// }
-// }
- }
-}
diff --git a/OpenSim/Region/OptionalModules/Materials/MaterialsModule.cs b/OpenSim/Region/OptionalModules/Materials/MaterialsModule.cs
new file mode 100644
index 0000000..e707154
--- /dev/null
+++ b/OpenSim/Region/OptionalModules/Materials/MaterialsModule.cs
@@ -0,0 +1,664 @@
+/*
+ * 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 System.Collections.Generic;
+using System.IO;
+using System.Reflection;
+using System.Security.Cryptography; // for computing md5 hash
+using log4net;
+using Mono.Addins;
+using Nini.Config;
+
+using OpenMetaverse;
+using OpenMetaverse.StructuredData;
+
+using OpenSim.Framework;
+using OpenSim.Framework.Servers;
+using OpenSim.Framework.Servers.HttpServer;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Region.Framework.Scenes;
+
+using Ionic.Zlib;
+
+// You will need to uncomment these lines if you are adding a region module to some other assembly which does not already
+// specify its assembly. Otherwise, the region modules in the assembly will not be picked up when OpenSimulator scans
+// the available DLLs
+//[assembly: Addin("MaterialsDemoModule", "1.0")]
+//[assembly: AddinDependency("OpenSim", "0.5")]
+
+namespace OpenSim.Region.OptionalModules.MaterialsDemoModule
+{
+ ///
+ ///
+ // # # ## ##### # # # # # ####
+ // # # # # # # ## # # ## # # #
+ // # # # # # # # # # # # # # #
+ // # ## # ###### ##### # # # # # # # # ###
+ // ## ## # # # # # ## # # ## # #
+ // # # # # # # # # # # # ####
+ //
+ // THIS MODULE IS FOR EXPERIMENTAL USE ONLY AND MAY CAUSE REGION OR ASSET CORRUPTION!
+ //
+ ////////////// WARNING //////////////////////////////////////////////////////////////////
+ /// This is an *Experimental* module for developing support for materials-capable viewers
+ /// This module should NOT be used in a production environment! It may cause data corruption and
+ /// viewer crashes. It should be only used to evaluate implementations of materials.
+ ///
+ /// Materials are persisted via SceneObjectPart.dynattrs. This is a relatively new feature
+ /// of OpenSimulator and is not field proven at the time this module was written. Persistence
+ /// may fail or become corrupt and this could cause viewer crashes due to erroneous materials
+ /// data being sent to viewers. Materials descriptions might survive IAR, OAR, or other means
+ /// of archiving however the texture resources used by these materials probably will not as they
+ /// may not be adequately referenced to ensure proper archiving.
+ ///
+ ///
+ ///
+ /// To enable this module, add this string at the bottom of OpenSim.ini:
+ /// [MaterialsDemoModule]
+ ///
+ ///
+ ///
+
+ [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "MaterialsDemoModule")]
+ public class MaterialsDemoModule : INonSharedRegionModule
+ {
+ private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
+ public string Name { get { return "MaterialsDemoModule"; } }
+
+ public Type ReplaceableInterface { get { return null; } }
+
+ private Scene m_scene = null;
+ private bool m_enabled = false;
+
+ public Dictionary m_knownMaterials = new Dictionary();
+
+ public void Initialise(IConfigSource source)
+ {
+ m_enabled = (source.Configs["MaterialsDemoModule"] != null);
+ if (!m_enabled)
+ return;
+
+ m_log.DebugFormat("[MaterialsDemoModule]: Initialized");
+ }
+
+ public void Close()
+ {
+ if (!m_enabled)
+ return;
+
+ //m_log.DebugFormat("[MaterialsDemoModule]: CLOSED MODULE");
+ }
+
+ public void AddRegion(Scene scene)
+ {
+ if (!m_enabled)
+ return;
+
+ //m_log.DebugFormat("[MaterialsDemoModule]: REGION {0} ADDED", scene.RegionInfo.RegionName);
+
+ m_scene = scene;
+ m_scene.EventManager.OnRegisterCaps += OnRegisterCaps;
+ m_scene.EventManager.OnObjectAddedToScene += EventManager_OnObjectAddedToScene;
+// m_scene.EventManager.OnGatherUuids += GatherMaterialsUuids;
+ }
+
+ void EventManager_OnObjectAddedToScene(SceneObjectGroup obj)
+ {
+ foreach (var part in obj.Parts)
+ if (part != null)
+ GetStoredMaterialsForPart(part);
+ }
+
+ void OnRegisterCaps(OpenMetaverse.UUID agentID, OpenSim.Framework.Capabilities.Caps caps)
+ {
+ string capsBase = "/CAPS/" + caps.CapsObjectPath;
+
+ IRequestHandler renderMaterialsPostHandler
+ = new RestStreamHandler("POST", capsBase + "/", RenderMaterialsPostCap, "RenderMaterials", null);
+ caps.RegisterHandler("RenderMaterials", renderMaterialsPostHandler);
+
+ // OpenSimulator CAPs infrastructure seems to be somewhat hostile towards any CAP that requires both GET
+ // and POST handlers, (at least at the time this was originally written), so we first set up a POST
+ // handler normally and then add a GET handler via MainServer
+
+ IRequestHandler renderMaterialsGetHandler
+ = new RestStreamHandler("GET", capsBase + "/", RenderMaterialsGetCap, "RenderMaterials", null);
+ MainServer.Instance.AddStreamHandler(renderMaterialsGetHandler);
+
+ // materials viewer seems to use either POST or PUT, so assign POST handler for PUT as well
+ IRequestHandler renderMaterialsPutHandler
+ = new RestStreamHandler("PUT", capsBase + "/", RenderMaterialsPostCap, "RenderMaterials", null);
+ MainServer.Instance.AddStreamHandler(renderMaterialsPutHandler);
+ }
+
+ public void RemoveRegion(Scene scene)
+ {
+ if (!m_enabled)
+ return;
+
+ m_scene.EventManager.OnRegisterCaps -= OnRegisterCaps;
+ m_scene.EventManager.OnObjectAddedToScene -= EventManager_OnObjectAddedToScene;
+// m_scene.EventManager.OnGatherUuids -= GatherMaterialsUuids;
+
+ //m_log.DebugFormat("[MaterialsDemoModule]: REGION {0} REMOVED", scene.RegionInfo.RegionName);
+ }
+
+ public void RegionLoaded(Scene scene)
+ {
+ }
+
+ OSDMap GetMaterial(UUID id)
+ {
+ OSDMap map = null;
+ lock (m_knownMaterials)
+ {
+ if (m_knownMaterials.ContainsKey(id))
+ {
+ map = new OSDMap();
+ map["ID"] = OSD.FromBinary(id.GetBytes());
+ map["Material"] = m_knownMaterials[id];
+ }
+ }
+ return map;
+ }
+
+ void GetStoredMaterialsForPart(SceneObjectPart part)
+ {
+ OSD OSMaterials = null;
+ OSDArray matsArr = null;
+
+ if (part.DynAttrs == null)
+ {
+ //m_log.Warn("[MaterialsDemoModule]: NULL DYNATTRS :( ");
+ return;
+ }
+
+ lock (part.DynAttrs)
+ {
+ if (part.DynAttrs.ContainsStore("OpenSim", "Materials"))
+ {
+ OSDMap materialsStore = part.DynAttrs.GetStore("OpenSim", "Materials");
+
+ if (materialsStore == null)
+ return;
+
+ materialsStore.TryGetValue("Materials", out OSMaterials);
+ }
+
+ if (OSMaterials != null && OSMaterials is OSDArray)
+ matsArr = OSMaterials as OSDArray;
+ else
+ return;
+ }
+
+ //m_log.Info("[MaterialsDemoModule]: OSMaterials: " + OSDParser.SerializeJsonString(OSMaterials));
+
+ if (matsArr == null)
+ {
+ //m_log.Info("[MaterialsDemoModule]: matsArr is null :( ");
+ return;
+ }
+
+ foreach (OSD elemOsd in matsArr)
+ {
+ if (elemOsd != null && elemOsd is OSDMap)
+ {
+ OSDMap matMap = elemOsd as OSDMap;
+ if (matMap.ContainsKey("ID") && matMap.ContainsKey("Material"))
+ {
+ try
+ {
+ lock (m_knownMaterials)
+ m_knownMaterials[matMap["ID"].AsUUID()] = (OSDMap)matMap["Material"];
+ }
+ catch (Exception e)
+ {
+ m_log.Warn("[MaterialsDemoModule]: exception decoding persisted material ", e);
+ }
+ }
+ }
+ }
+ }
+
+ void StoreMaterialsForPart(SceneObjectPart part)
+ {
+ try
+ {
+ if (part == null || part.Shape == null)
+ return;
+
+ Dictionary mats = new Dictionary();
+
+ Primitive.TextureEntry te = part.Shape.Textures;
+
+ if (te.DefaultTexture != null)
+ {
+ lock (m_knownMaterials)
+ {
+ if (m_knownMaterials.ContainsKey(te.DefaultTexture.MaterialID))
+ mats[te.DefaultTexture.MaterialID] = m_knownMaterials[te.DefaultTexture.MaterialID];
+ }
+ }
+
+ if (te.FaceTextures != null)
+ {
+ foreach (var face in te.FaceTextures)
+ {
+ if (face != null)
+ {
+ lock (m_knownMaterials)
+ {
+ if (m_knownMaterials.ContainsKey(face.MaterialID))
+ mats[face.MaterialID] = m_knownMaterials[face.MaterialID];
+ }
+ }
+ }
+ }
+ if (mats.Count == 0)
+ return;
+
+ OSDArray matsArr = new OSDArray();
+ foreach (KeyValuePair kvp in mats)
+ {
+ OSDMap matOsd = new OSDMap();
+ matOsd["ID"] = OSD.FromUUID(kvp.Key);
+ matOsd["Material"] = kvp.Value;
+ matsArr.Add(matOsd);
+ }
+
+ OSDMap OSMaterials = new OSDMap();
+ OSMaterials["Materials"] = matsArr;
+
+ lock (part.DynAttrs)
+ part.DynAttrs.SetStore("OpenSim", "Materials", OSMaterials);
+ }
+ catch (Exception e)
+ {
+ m_log.Warn("[MaterialsDemoModule]: exception in StoreMaterialsForPart() ", e);
+ }
+ }
+
+ public string RenderMaterialsPostCap(string request, string path,
+ string param, IOSHttpRequest httpRequest,
+ IOSHttpResponse httpResponse)
+ {
+ //m_log.Debug("[MaterialsDemoModule]: POST cap handler");
+
+ OSDMap req = (OSDMap)OSDParser.DeserializeLLSDXml(request);
+ OSDMap resp = new OSDMap();
+
+ OSDMap materialsFromViewer = null;
+
+ OSDArray respArr = new OSDArray();
+
+ if (req.ContainsKey("Zipped"))
+ {
+ OSD osd = null;
+
+ byte[] inBytes = req["Zipped"].AsBinary();
+
+ try
+ {
+ osd = ZDecompressBytesToOsd(inBytes);
+
+ if (osd != null)
+ {
+ if (osd is OSDArray) // assume array of MaterialIDs designating requested material entries
+ {
+ foreach (OSD elem in (OSDArray)osd)
+ {
+
+ try
+ {
+ UUID id = new UUID(elem.AsBinary(), 0);
+
+ lock (m_knownMaterials)
+ {
+ if (m_knownMaterials.ContainsKey(id))
+ {
+ //m_log.Info("[MaterialsDemoModule]: request for known material ID: " + id.ToString());
+ OSDMap matMap = new OSDMap();
+ matMap["ID"] = OSD.FromBinary(id.GetBytes());
+
+ matMap["Material"] = m_knownMaterials[id];
+ respArr.Add(matMap);
+ }
+ else
+ m_log.Info("[MaterialsDemoModule]: request for UNKNOWN material ID: " + id.ToString());
+ }
+ }
+ catch (Exception e)
+ {
+ // report something here?
+ continue;
+ }
+ }
+ }
+ else if (osd is OSDMap) // reqest to assign a material
+ {
+ materialsFromViewer = osd as OSDMap;
+
+ if (materialsFromViewer.ContainsKey("FullMaterialsPerFace"))
+ {
+ OSD matsOsd = materialsFromViewer["FullMaterialsPerFace"];
+ if (matsOsd is OSDArray)
+ {
+ OSDArray matsArr = matsOsd as OSDArray;
+
+ try
+ {
+ foreach (OSDMap matsMap in matsArr)
+ {
+ //m_log.Debug("[MaterialsDemoModule]: processing matsMap: " + OSDParser.SerializeJsonString(matsMap));
+
+ uint primLocalID = 0;
+ try { primLocalID = matsMap["ID"].AsUInteger(); }
+ catch (Exception e) { m_log.Warn("[MaterialsDemoModule]: cannot decode \"ID\" from matsMap: " + e.Message); }
+ //m_log.Debug("[MaterialsDemoModule]: primLocalID: " + primLocalID.ToString());
+
+ OSDMap mat = null;
+ try { mat = matsMap["Material"] as OSDMap; }
+ catch (Exception e) { m_log.Warn("[MaterialsDemoModule]: cannot decode \"Material\" from matsMap: " + e.Message); }
+ //m_log.Debug("[MaterialsDemoModule]: mat: " + OSDParser.SerializeJsonString(mat));
+
+ UUID id;
+ if (mat == null)
+ {
+ id = UUID.Zero;
+ }
+ else
+ {
+ id = HashOsd(mat);
+ lock (m_knownMaterials)
+ m_knownMaterials[id] = mat;
+ }
+
+ var sop = m_scene.GetSceneObjectPart(primLocalID);
+ if (sop == null)
+ m_log.Debug("[MaterialsDemoModule]: null SOP for localId: " + primLocalID.ToString());
+ else
+ {
+ var te = new Primitive.TextureEntry(sop.Shape.TextureEntry, 0, sop.Shape.TextureEntry.Length);
+
+ if (te == null)
+ {
+ m_log.Debug("[MaterialsDemoModule]: null TextureEntry for localId: " + primLocalID.ToString());
+ }
+ else
+ {
+ int face = -1;
+
+ if (matsMap.ContainsKey("Face"))
+ {
+ face = matsMap["Face"].AsInteger();
+ if (te.FaceTextures == null) // && face == 0)
+ {
+ if (te.DefaultTexture == null)
+ m_log.Debug("[MaterialsDemoModule]: te.DefaultTexture is null");
+ else
+ te.DefaultTexture.MaterialID = id;
+ }
+ else
+ {
+ if (te.FaceTextures.Length >= face - 1)
+ {
+ if (te.FaceTextures[face] == null)
+ te.DefaultTexture.MaterialID = id;
+ else
+ te.FaceTextures[face].MaterialID = id;
+ }
+ }
+ }
+ else
+ {
+ if (te.DefaultTexture != null)
+ te.DefaultTexture.MaterialID = id;
+ }
+
+ //m_log.DebugFormat("[MaterialsDemoModule]: in \"{0}\", setting material ID for face {1} to {2}", sop.Name, face, id);
+
+ //we cant use sop.UpdateTextureEntry(te); because it filters so do it manually
+
+ if (sop.ParentGroup != null)
+ {
+ sop.Shape.TextureEntry = te.GetBytes();
+ sop.TriggerScriptChangedEvent(Changed.TEXTURE);
+ sop.UpdateFlag = UpdateRequired.FULL;
+ sop.ParentGroup.HasGroupChanged = true;
+
+ sop.ScheduleFullUpdate();
+
+ StoreMaterialsForPart(sop);
+ }
+ }
+ }
+ }
+ }
+ catch (Exception e)
+ {
+ m_log.Warn("[MaterialsDemoModule]: exception processing received material ", e);
+ }
+ }
+ }
+ }
+ }
+
+ }
+ catch (Exception e)
+ {
+ m_log.Warn("[MaterialsDemoModule]: exception decoding zipped CAP payload ", e);
+ //return "";
+ }
+ //m_log.Debug("[MaterialsDemoModule]: knownMaterials.Count: " + m_knownMaterials.Count.ToString());
+ }
+
+
+ resp["Zipped"] = ZCompressOSD(respArr, false);
+ string response = OSDParser.SerializeLLSDXmlString(resp);
+
+ //m_log.Debug("[MaterialsDemoModule]: cap request: " + request);
+ //m_log.Debug("[MaterialsDemoModule]: cap request (zipped portion): " + ZippedOsdBytesToString(req["Zipped"].AsBinary()));
+ //m_log.Debug("[MaterialsDemoModule]: cap response: " + response);
+ return response;
+ }
+
+
+ public string RenderMaterialsGetCap(string request, string path,
+ string param, IOSHttpRequest httpRequest,
+ IOSHttpResponse httpResponse)
+ {
+ //m_log.Debug("[MaterialsDemoModule]: GET cap handler");
+
+ OSDMap resp = new OSDMap();
+ int matsCount = 0;
+ OSDArray allOsd = new OSDArray();
+
+ lock (m_knownMaterials)
+ {
+ foreach (KeyValuePair kvp in m_knownMaterials)
+ {
+ OSDMap matMap = new OSDMap();
+
+ matMap["ID"] = OSD.FromBinary(kvp.Key.GetBytes());
+ matMap["Material"] = kvp.Value;
+ allOsd.Add(matMap);
+ matsCount++;
+ }
+ }
+
+ resp["Zipped"] = ZCompressOSD(allOsd, false);
+ //m_log.Debug("[MaterialsDemoModule]: matsCount: " + matsCount.ToString());
+
+ return OSDParser.SerializeLLSDXmlString(resp);
+ }
+
+ static string ZippedOsdBytesToString(byte[] bytes)
+ {
+ try
+ {
+ return OSDParser.SerializeJsonString(ZDecompressBytesToOsd(bytes));
+ }
+ catch (Exception e)
+ {
+ return "ZippedOsdBytesToString caught an exception: " + e.ToString();
+ }
+ }
+
+ ///
+ /// computes a UUID by hashing a OSD object
+ ///
+ ///
+ ///
+ private static UUID HashOsd(OSD osd)
+ {
+ using (var md5 = MD5.Create())
+ using (MemoryStream ms = new MemoryStream(OSDParser.SerializeLLSDBinary(osd, false)))
+ return new UUID(md5.ComputeHash(ms), 0);
+ }
+
+ public static OSD ZCompressOSD(OSD inOsd, bool useHeader)
+ {
+ OSD osd = null;
+
+ using (MemoryStream msSinkCompressed = new MemoryStream())
+ {
+ using (Ionic.Zlib.ZlibStream zOut = new Ionic.Zlib.ZlibStream(msSinkCompressed,
+ Ionic.Zlib.CompressionMode.Compress, CompressionLevel.BestCompression, true))
+ {
+ CopyStream(new MemoryStream(OSDParser.SerializeLLSDBinary(inOsd, useHeader)), zOut);
+ zOut.Close();
+ }
+
+ msSinkCompressed.Seek(0L, SeekOrigin.Begin);
+ osd = OSD.FromBinary( msSinkCompressed.ToArray());
+ }
+
+ return osd;
+ }
+
+
+ public static OSD ZDecompressBytesToOsd(byte[] input)
+ {
+ OSD osd = null;
+
+ using (MemoryStream msSinkUnCompressed = new MemoryStream())
+ {
+ using (Ionic.Zlib.ZlibStream zOut = new Ionic.Zlib.ZlibStream(msSinkUnCompressed, CompressionMode.Decompress, true))
+ {
+ CopyStream(new MemoryStream(input), zOut);
+ zOut.Close();
+ }
+ msSinkUnCompressed.Seek(0L, SeekOrigin.Begin);
+ osd = OSDParser.DeserializeLLSDBinary(msSinkUnCompressed.ToArray());
+ }
+
+ return osd;
+ }
+
+ static void CopyStream(System.IO.Stream input, System.IO.Stream output)
+ {
+ byte[] buffer = new byte[2048];
+ int len;
+ while ((len = input.Read(buffer, 0, 2048)) > 0)
+ {
+ output.Write(buffer, 0, len);
+ }
+
+ output.Flush();
+ }
+
+ // FIXME: This code is currently still in UuidGatherer since we cannot use Scene.EventManager as some
+ // calls to the gatherer are done for objects with no scene.
+// ///
+// /// Gather all of the texture asset UUIDs used to reference "Materials" such as normal and specular maps
+// ///
+// ///
+// ///
+// private void GatherMaterialsUuids(SceneObjectPart part, IDictionary assetUuids)
+// {
+// // scan thru the dynAttrs map of this part for any textures used as materials
+// OSD osdMaterials = null;
+//
+// lock (part.DynAttrs)
+// {
+// if (part.DynAttrs.ContainsStore("OpenSim", "Materials"))
+// {
+// OSDMap materialsStore = part.DynAttrs.GetStore("OpenSim", "Materials");
+// if (materialsStore == null)
+// return;
+//
+// materialsStore.TryGetValue("Materials", out osdMaterials);
+// }
+//
+// if (osdMaterials != null)
+// {
+// //m_log.Info("[UUID Gatherer]: found Materials: " + OSDParser.SerializeJsonString(osd));
+//
+// if (osdMaterials is OSDArray)
+// {
+// OSDArray matsArr = osdMaterials as OSDArray;
+// foreach (OSDMap matMap in matsArr)
+// {
+// try
+// {
+// if (matMap.ContainsKey("Material"))
+// {
+// OSDMap mat = matMap["Material"] as OSDMap;
+// if (mat.ContainsKey("NormMap"))
+// {
+// UUID normalMapId = mat["NormMap"].AsUUID();
+// if (normalMapId != UUID.Zero)
+// {
+// assetUuids[normalMapId] = AssetType.Texture;
+// //m_log.Info("[UUID Gatherer]: found normal map ID: " + normalMapId.ToString());
+// }
+// }
+// if (mat.ContainsKey("SpecMap"))
+// {
+// UUID specularMapId = mat["SpecMap"].AsUUID();
+// if (specularMapId != UUID.Zero)
+// {
+// assetUuids[specularMapId] = AssetType.Texture;
+// //m_log.Info("[UUID Gatherer]: found specular map ID: " + specularMapId.ToString());
+// }
+// }
+// }
+//
+// }
+// catch (Exception e)
+// {
+// m_log.Warn("[MaterialsDemoModule]: exception getting materials: " + e.Message);
+// }
+// }
+// }
+// }
+// }
+// }
+ }
+}
--
cgit v1.1