Make the concept of namespaces explicit in dynamic attributes

This is in order to reduce the likelihood of naming clashes, make it easier to filter in/out attributes, ensure uniformity, etc.
All dynattrs in the opensim distro itself or likely future ones should be in the "OpenSim" namespace.
This does alter the underlying dynattrs data structure.  All data in previous structures may not be available, though old structures should not cause errors.
This is done without notice since this feature has been explicitly labelled as experimental, subject to change and has not been in a release.
However, existing materials data is being preserved by moving it to the "Materials" store in the "OpenSim" namespace.

6 files changed, 72 insertions, 43 deletions

diff --git a/OpenSim/Region/CoreModules/Framework/DynamicAttributes/DAExampleModule.cs b/OpenSim/Region/CoreModules/Framework/DynamicAttributes/DAExampleModule.cs
index 1f1568f..0c632b1 100644
--- a/OpenSim/Region/CoreModules/Framework/DynamicAttributes/DAExampleModule.cs
+++ b/OpenSim/Region/CoreModules/Framework/DynamicAttributes/DAExampleModule.cs
@@ -44,11 +44,12 @@ namespace OpenSim.Region.CoreModules.Framework.DynamicAttributes.DAExampleModule
     [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "DAExampleModule")]
     public class DAExampleModule : INonSharedRegionModule
     {
-//        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
-        private static readonly bool ENABLED = false;   // enable for testing
+        private readonly bool ENABLED = false;   // enable for testing
 
-        public const string DANamespace = "DAExample Module";
+        public const string Namespace = "Example";
+        public const string StoreName = "DA";
 
         protected Scene m_scene;
         protected IDialogModule m_dialogMod;
@@ -65,6 +66,8 @@ namespace OpenSim.Region.CoreModules.Framework.DynamicAttributes.DAExampleModule
                 m_scene = scene;
                 m_scene.EventManager.OnSceneGroupMove += OnSceneGroupMove;
                 m_dialogMod = m_scene.RequestModuleInterface<IDialogModule>();
+
+                m_log.DebugFormat("[DA EXAMPLE MODULE]: Added region {0}", m_scene.Name);
             }
         }
         
@@ -91,7 +94,7 @@ namespace OpenSim.Region.CoreModules.Framework.DynamicAttributes.DAExampleModule
             if (sop == null)
                 return true;
 
-            if (!sop.DynAttrs.TryGetValue(DANamespace, out attrs))
+            if (!sop.DynAttrs.TryGetStore(Namespace, StoreName, out attrs))
                 attrs = new OSDMap();
             
             OSDInteger newValue;
@@ -106,12 +109,14 @@ namespace OpenSim.Region.CoreModules.Framework.DynamicAttributes.DAExampleModule
                         
                 attrs["moves"] = newValue;
 
-                sop.DynAttrs[DANamespace] = attrs;
+                sop.DynAttrs.SetStore(Namespace, StoreName, attrs);
             }
 
             sop.ParentGroup.HasGroupChanged = true;
     
-            m_dialogMod.SendGeneralAlert(string.Format("{0} {1} moved {2} times", sop.Name, sop.UUID, newValue));
+            string msg = string.Format("{0} {1} moved {2} times", sop.Name, sop.UUID, newValue);
+            m_log.DebugFormat("[DA EXAMPLE MODULE]: {0}", msg);
+            m_dialogMod.SendGeneralAlert(msg);
             
             return true;
         }
diff --git a/OpenSim/Region/CoreModules/Framework/DynamicAttributes/DOExampleModule.cs b/OpenSim/Region/CoreModules/Framework/DynamicAttributes/DOExampleModule.cs
index 650aa35..166a994 100644
--- a/OpenSim/Region/CoreModules/Framework/DynamicAttributes/DOExampleModule.cs
+++ b/OpenSim/Region/CoreModules/Framework/DynamicAttributes/DOExampleModule.cs
@@ -64,8 +64,8 @@ namespace OpenSim.Region.Framework.DynamicAttributes.DOExampleModule
 
         private Scene m_scene;
         private IDialogModule m_dialogMod;
-        
-        public string Name { get { return "DOExample Module"; } }        
+
+        public string Name { get { return "DO"; } }        
         public Type ReplaceableInterface { get { return null; } }        
 
         public void Initialise(IConfigSource source) {}
@@ -106,7 +106,7 @@ namespace OpenSim.Region.Framework.DynamicAttributes.DOExampleModule
 
 //            Console.WriteLine("Here for {0}", so.Name);
 
-            if (rootPart.DynAttrs.TryGetValue(DAExampleModule.DANamespace, out attrs))
+            if (rootPart.DynAttrs.TryGetStore(DAExampleModule.Namespace, DAExampleModule.StoreName, out attrs))
             {
                 movesSoFar = attrs["moves"].AsInteger();
 
@@ -114,7 +114,7 @@ namespace OpenSim.Region.Framework.DynamicAttributes.DOExampleModule
                     "[DO EXAMPLE MODULE]: Found saved moves {0} for {1} in {2}", movesSoFar, so.Name, m_scene.Name);
             }
 
-            rootPart.DynObjs.Add(Name, new MyObject(movesSoFar));
+            rootPart.DynObjs.Add(DAExampleModule.Namespace, Name, new MyObject(movesSoFar));
         }
         
         private bool OnSceneGroupMove(UUID groupId, Vector3 delta)
diff --git a/OpenSim/Region/CoreModules/World/Serialiser/Tests/SerialiserTests.cs b/OpenSim/Region/CoreModules/World/Serialiser/Tests/SerialiserTests.cs
index b4348c9..66059fb 100644
--- a/OpenSim/Region/CoreModules/World/Serialiser/Tests/SerialiserTests.cs
+++ b/OpenSim/Region/CoreModules/World/Serialiser/Tests/SerialiserTests.cs
@@ -144,7 +144,20 @@ namespace OpenSim.Region.CoreModules.World.Serialiser.Tests
                     <Flags>None</Flags>
                     <CollisionSound><Guid>00000000-0000-0000-0000-000000000000</Guid></CollisionSound>
                     <CollisionSoundVolume>0</CollisionSoundVolume>
-                    <DynAttrs><llsd><map><key>MyStore</key><map><key>the answer</key><integer>42</integer></map></map></llsd></DynAttrs>
+                    <DynAttrs>
+                        <llsd>
+                            <map>
+                                <key>MyNamespace</key>
+                                <map>                                
+                                    <key>MyStore</key>
+                                    <map>   
+                                        <key>the answer</key>
+                                        <integer>42</integer>
+                                    </map>
+                                </map>
+                            </map>
+                        </llsd>
+                    </DynAttrs>
                 </SceneObjectPart>
             </RootPart>
             <OtherParts />
@@ -333,7 +346,20 @@ namespace OpenSim.Region.CoreModules.World.Serialiser.Tests
                 <EveryoneMask>0</EveryoneMask>
                 <NextOwnerMask>2147483647</NextOwnerMask>
                 <Flags>None</Flags>
-                <DynAttrs><llsd><map><key>MyStore</key><map><key>last words</key><string>Rosebud</string></map></map></llsd></DynAttrs>
+                <DynAttrs>
+                    <llsd>
+                        <map>
+                            <key>MyNamespace</key>
+                            <map>                                
+                                <key>MyStore</key>
+                                <map>   
+                                    <key>last words</key>
+                                    <string>Rosebud</string>
+                                </map>
+                            </map>
+                        </map>
+                    </llsd>
+                </DynAttrs>
                 <SitTargetAvatar><UUID>00000000-0000-0000-0000-000000000000</UUID></SitTargetAvatar>
             </SceneObjectPart>
             <OtherParts />
@@ -362,7 +388,7 @@ namespace OpenSim.Region.CoreModules.World.Serialiser.Tests
             Assert.That(rootPart.UUID, Is.EqualTo(new UUID("e6a5a05e-e8cc-4816-8701-04165e335790")));
             Assert.That(rootPart.CreatorID, Is.EqualTo(new UUID("a6dacf01-4636-4bb9-8a97-30609438af9d")));
             Assert.That(rootPart.Name, Is.EqualTo("PrimMyRide"));
-            OSDMap store = rootPart.DynAttrs["MyStore"];
+            OSDMap store = rootPart.DynAttrs.GetStore("MyNamespace", "MyStore");
             Assert.AreEqual(42, store["the answer"].AsInteger());
 
             // TODO: Check other properties
@@ -414,13 +440,14 @@ namespace OpenSim.Region.CoreModules.World.Serialiser.Tests
             rp.CreatorID = rpCreatorId;
             rp.Shape = shape;
 
+            string daNamespace = "MyNamespace";
             string daStoreName = "MyStore";
             string daKey = "foo";
             string daValue = "bar";
             OSDMap myStore = new OSDMap();
             myStore.Add(daKey, daValue);
             rp.DynAttrs = new DAMap();
-            rp.DynAttrs[daStoreName] = myStore;
+            rp.DynAttrs.SetStore(daNamespace, daStoreName, myStore);
 
             SceneObjectGroup so = new SceneObjectGroup(rp);
 
@@ -481,7 +508,7 @@ namespace OpenSim.Region.CoreModules.World.Serialiser.Tests
             Assert.That(name, Is.EqualTo(rpName));
             Assert.That(creatorId, Is.EqualTo(rpCreatorId));
             Assert.NotNull(daMap);
-            Assert.AreEqual(daValue, daMap[daStoreName][daKey].AsString());
+            Assert.AreEqual(daValue, daMap.GetStore(daNamespace, daStoreName)[daKey].AsString());
         }
 
         [Test]
@@ -496,7 +523,7 @@ namespace OpenSim.Region.CoreModules.World.Serialiser.Tests
             Assert.That(rootPart.UUID, Is.EqualTo(new UUID("9be68fdd-f740-4a0f-9675-dfbbb536b946")));
             Assert.That(rootPart.CreatorID, Is.EqualTo(new UUID("b46ef588-411e-4a8b-a284-d7dcfe8e74ef")));
             Assert.That(rootPart.Name, Is.EqualTo("PrimFun"));
-            OSDMap store = rootPart.DynAttrs["MyStore"];
+            OSDMap store = rootPart.DynAttrs.GetStore("MyNamespace", "MyStore");
             Assert.AreEqual("Rosebud", store["last words"].AsString());
 
             // TODO: Check other properties
@@ -522,13 +549,14 @@ namespace OpenSim.Region.CoreModules.World.Serialiser.Tests
             rp.CreatorID = rpCreatorId;
             rp.Shape = shape;
 
+            string daNamespace = "MyNamespace";
             string daStoreName = "MyStore";
             string daKey = "foo";
             string daValue = "bar";
             OSDMap myStore = new OSDMap();
             myStore.Add(daKey, daValue);
             rp.DynAttrs = new DAMap();
-            rp.DynAttrs[daStoreName] = myStore;
+            rp.DynAttrs.SetStore(daNamespace, daStoreName, myStore);
 
             SceneObjectGroup so = new SceneObjectGroup(rp);
 
@@ -585,7 +613,7 @@ namespace OpenSim.Region.CoreModules.World.Serialiser.Tests
             Assert.That(name, Is.EqualTo(rpName));
             Assert.That(creatorId, Is.EqualTo(rpCreatorId));
             Assert.NotNull(daMap);
-            Assert.AreEqual(daValue, daMap[daStoreName][daKey].AsString());
+            Assert.AreEqual(daValue, daMap.GetStore(daNamespace, daStoreName)[daKey].AsString());
         }
     }
 }
\ No newline at end of file
diff --git a/OpenSim/Region/Framework/Scenes/Serialization/SceneObjectSerializer.cs b/OpenSim/Region/Framework/Scenes/Serialization/SceneObjectSerializer.cs
index 3882b45..945745e 100644
--- a/OpenSim/Region/Framework/Scenes/Serialization/SceneObjectSerializer.cs
+++ b/OpenSim/Region/Framework/Scenes/Serialization/SceneObjectSerializer.cs
@@ -1290,7 +1290,7 @@ namespace OpenSim.Region.Framework.Scenes.Serialization
             if (sop.MediaUrl != null)
                 writer.WriteElementString("MediaUrl", sop.MediaUrl.ToString());
             
-            if (sop.DynAttrs.Count > 0)
+            if (sop.DynAttrs.CountNamespaces > 0)
             {
                 writer.WriteStartElement("DynAttrs");
                 sop.DynAttrs.WriteXml(writer);
diff --git a/OpenSim/Region/Framework/Scenes/UuidGatherer.cs b/OpenSim/Region/Framework/Scenes/UuidGatherer.cs
index 0e83781..586b59d 100644
--- a/OpenSim/Region/Framework/Scenes/UuidGatherer.cs
+++ b/OpenSim/Region/Framework/Scenes/UuidGatherer.cs
@@ -212,7 +212,6 @@ namespace OpenSim.Region.Framework.Scenes
 //            }
 //        }
 
-
         /// <summary>
         /// Gather all of the texture asset UUIDs used to reference "Materials" such as normal and specular maps
         /// </summary>
@@ -221,20 +220,23 @@ namespace OpenSim.Region.Framework.Scenes
         public void GatherMaterialsUuids(SceneObjectPart part, IDictionary<UUID, AssetType> assetUuids)
         {
             // scan thru the dynAttrs map of this part for any textures used as materials
-            OSDMap OSMaterials = null;
+            OSD osdMaterials = null;
 
             lock (part.DynAttrs)
             {
-                if (part.DynAttrs.ContainsKey("OS:Materials"))
-                    OSMaterials = part.DynAttrs["OS:Materials"];
-                if (OSMaterials != null && OSMaterials.ContainsKey("Materials"))
+                if (part.DynAttrs.ContainsStore("OpenSim", "Materials"))
+                {
+                    OSDMap materialsStore = part.DynAttrs.GetStore("OpenSim", "Materials");
+                    materialsStore.TryGetValue("Materials", out osdMaterials);
+                }
+
+                if (osdMaterials != null)
                 {
-                    OSD osd = OSMaterials["Materials"];
                     //m_log.Info("[UUID Gatherer]: found Materials: " + OSDParser.SerializeJsonString(osd));
 
-                    if (osd is OSDArray)
+                    if (osdMaterials is OSDArray)
                     {
-                        OSDArray matsArr = osd as OSDArray;
+                        OSDArray matsArr = osdMaterials as OSDArray;
                         foreach (OSDMap matMap in matsArr)
                         {
                             try
diff --git a/OpenSim/Region/OptionalModules/Materials/MaterialsDemoModule.cs b/OpenSim/Region/OptionalModules/Materials/MaterialsDemoModule.cs
index 4ab6609..5b15a73 100644
--- a/OpenSim/Region/OptionalModules/Materials/MaterialsDemoModule.cs
+++ b/OpenSim/Region/OptionalModules/Materials/MaterialsDemoModule.cs
@@ -178,7 +178,7 @@ namespace OpenSim.Region.OptionalModules.MaterialsDemoModule
 
         void GetStoredMaterialsForPart(SceneObjectPart part)
         { 
-            OSDMap OSMaterials = null;
+            OSD OSMaterials = null;
             OSDArray matsArr = null;
 
             if (part.DynAttrs == null)
@@ -188,23 +188,20 @@ namespace OpenSim.Region.OptionalModules.MaterialsDemoModule
 
             lock (part.DynAttrs)
             {
-                if (part.DynAttrs.ContainsKey("OS:Materials"))
-                    OSMaterials = part.DynAttrs["OS:Materials"];
-                if (OSMaterials != null && OSMaterials.ContainsKey("Materials"))
+                if (part.DynAttrs.ContainsStore("OpenSim", "Materials"))
                 {
-
-                    OSD osd = OSMaterials["Materials"];
-                    if (osd is OSDArray)
-                        matsArr = osd as OSDArray;
+                    OSDMap materialsStore = part.DynAttrs.GetStore("OpenSim", "Materials");
+                    materialsStore.TryGetValue("Materials", out OSMaterials);
                 }
-            }
 
-            if (OSMaterials == null)
-                return;
+                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 :( ");
@@ -215,7 +212,6 @@ namespace OpenSim.Region.OptionalModules.MaterialsDemoModule
             {
                 if (elemOsd != null && elemOsd is OSDMap)
                 {
-
                     OSDMap matMap = elemOsd as OSDMap;
                     if (matMap.ContainsKey("ID") && matMap.ContainsKey("Material"))
                     {
@@ -232,7 +228,6 @@ namespace OpenSim.Region.OptionalModules.MaterialsDemoModule
             }
         }
 
-        
         void StoreMaterialsForPart(SceneObjectPart part)
         {
             try
@@ -277,7 +272,7 @@ namespace OpenSim.Region.OptionalModules.MaterialsDemoModule
                 OSMaterials["Materials"] = matsArr;
 
                 lock (part.DynAttrs)
-                    part.DynAttrs["OS:Materials"] = OSMaterials;
+                    part.DynAttrs.SetStore("OpenSim", "Materials", OSMaterials);
             }
             catch (Exception e)
             {
@@ -285,7 +280,6 @@ namespace OpenSim.Region.OptionalModules.MaterialsDemoModule
             }
         }
 
-
         public string RenderMaterialsPostCap(string request, string path,
                 string param, IOSHttpRequest httpRequest,
                 IOSHttpResponse httpResponse)