Add prototype dynamic objects map for scene object parts

This allows region modules to add dynamic objects to SOPs rather than having to continually push and pull OSD dynamic attributes.
This is to explore the original MOAP use case for dynamic attributes where it could be very awkward and possibly time-consuming to keep reconstructing MediaEntrys from stored DynamicAttributes.
This commit adds a DOExampleModule to demonstrate/evolve this code.
Dynamic objects involve no storage or persistence changes - the 'backing store' for any data that does need to be saved will remain the DAMap.
DOExampleModule in this commit only attaches a fresh dynamic object.  Actually constructing this from stored dynamic attributes and handling persistence is left for later.
These changes should affect no existing functionality, though it may or may not reveal necessary changes in DAMap down the road.

4 files changed, 238 insertions, 1 deletions

diff --git a/OpenSim/Framework/DAMap.cs b/OpenSim/Framework/DAMap.cs
index 64cea77..df4a6bc 100644
--- a/OpenSim/Framework/DAMap.cs
+++ b/OpenSim/Framework/DAMap.cs
@@ -180,7 +180,7 @@ namespace OpenSim.Framework
         /// Validate the key used for storing separate data stores.
         /// </summary>
         /// <param name='key'></param>
-        private static void ValidateKey(string key)
+        public static void ValidateKey(string key)
         {
             if (key.Length < MIN_STORE_NAME_LENGTH)
                 throw new Exception("Minimum store name length is " + MIN_STORE_NAME_LENGTH);
diff --git a/OpenSim/Framework/DOMap.cs b/OpenSim/Framework/DOMap.cs
new file mode 100644
index 0000000..755e129
--- /dev/null
+++ b/OpenSim/Framework/DOMap.cs
@@ -0,0 +1,98 @@
+/*
+ * 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;
+using System.Collections.Generic;
+using System.IO;
+using System.Text;
+using System.Xml;
+using System.Xml.Schema;
+using System.Xml.Serialization;
+using OpenMetaverse;
+using OpenMetaverse.StructuredData;
+
+namespace OpenSim.Framework
+{
+    /// <summary>
+    /// This class stores and retrieves dynamic objects.
+    /// </summary>
+    /// <remarks>
+    /// Experimental - DO NOT USE.
+    /// </remarks>
+    public class DOMap
+    {
+        private IDictionary<string, object> m_map;
+        
+        public void Add(string key, object dynObj)
+        {
+            DAMap.ValidateKey(key);
+
+            lock (this)
+            {
+                if (m_map == null)
+                    m_map = new Dictionary<string, object>();
+
+                m_map.Add(key, dynObj);
+            }
+        }
+
+        public bool ContainsKey(string key)
+        {
+            return Get(key) != null;
+        }
+
+        /// <summary>
+        /// Get a dynamic object
+        /// </summary>
+        /// <remarks>
+        /// Not providing an index method so that users can't casually overwrite each other's objects.
+        /// </remarks>
+        /// <param name='key'></param>
+        public object Get(string key)
+        {
+            lock (this)
+            {
+                if (m_map == null)
+                    return null;
+                else
+                    return m_map[key];
+            }
+        }
+
+        public bool Remove(string key)
+        {
+            lock (this)
+            {
+                if (m_map == null)
+                    return false;
+                else
+                    return m_map.Remove(key);
+            }
+        }
+    }
+}
\ No newline at end of file
diff --git a/OpenSim/Region/CoreModules/Framework/DynamicAttributes/DOExampleModule.cs b/OpenSim/Region/CoreModules/Framework/DynamicAttributes/DOExampleModule.cs
new file mode 100644
index 0000000..71bb3f0
--- /dev/null
+++ b/OpenSim/Region/CoreModules/Framework/DynamicAttributes/DOExampleModule.cs
@@ -0,0 +1,117 @@
+/*
+ * 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.Reflection;
+using log4net;
+using Mono.Addins;
+using Nini.Config;
+using OpenMetaverse;
+using OpenMetaverse.Packets;
+using OpenMetaverse.StructuredData;
+using OpenSim.Framework;
+using OpenSim.Region.Framework;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Region.Framework.Scenes;
+
+namespace OpenSim.Region.Framework.DynamicAttributes.DOExampleModule
+{
+    /// <summary>
+    /// Example module for experimenting with and demonstrating dynamic object ideas.
+    /// </summary>
+    [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "DOExampleModule")]
+    public class DOExampleModule : INonSharedRegionModule
+    {
+        public class MyObject
+        {
+            public int Moves { get; set; }
+        }
+
+ //        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
+        private static readonly bool ENABLED = false;   // enable for testing
+
+        private Scene m_scene;
+        private IDialogModule m_dialogMod;
+        
+        public string Name { get { return "DOExample Module"; } }        
+        public Type ReplaceableInterface { get { return null; } }        
+
+        public void Initialise(IConfigSource source) {}
+        
+        public void AddRegion(Scene scene)
+        {
+            if (ENABLED)
+            {
+                m_scene = scene;
+                m_scene.EventManager.OnObjectAddedToScene += OnObjectAddedToScene;
+                m_scene.EventManager.OnSceneGroupMove += OnSceneGroupMove;
+                m_dialogMod = m_scene.RequestModuleInterface<IDialogModule>();
+            }
+        }
+        
+        public void RemoveRegion(Scene scene) 
+        {
+            if (ENABLED)
+            {
+                m_scene.EventManager.OnSceneGroupMove -= OnSceneGroupMove;
+            }
+        }
+        
+        public void RegionLoaded(Scene scene) {}
+        
+        public void Close() 
+        {
+            RemoveRegion(m_scene);
+        }
+
+        private void OnObjectAddedToScene(SceneObjectGroup so)
+        {
+            so.RootPart.DynObjs.Add(Name, new MyObject());
+        }
+        
+        private bool OnSceneGroupMove(UUID groupId, Vector3 delta)
+        {
+            SceneObjectGroup so = m_scene.GetSceneObjectGroup(groupId);
+
+            if (so == null)
+                return true;
+
+            object rawObj = so.RootPart.DynObjs.Get(Name);
+
+            if (rawObj != null)
+            {
+                MyObject myObj = (MyObject)rawObj;
+               
+                m_dialogMod.SendGeneralAlert(string.Format("{0} {1} moved {2} times", so.Name, so.UUID, ++myObj.Moves));
+            }
+            
+            return true;
+        }        
+    }
+}
\ No newline at end of file
diff --git a/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs b/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
index 3e9a6fa..ee7c4f4 100644
--- a/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
+++ b/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
@@ -129,6 +129,27 @@ namespace OpenSim.Region.Framework.Scenes
         /// Dynamic attributes can be created and deleted as required.
         /// </summary>
         public DAMap DynAttrs { get; set; }
+
+        private DOMap m_dynObjs;
+
+        /// <summary>
+        /// Dynamic objects that can be created and deleted as required.
+        /// </summary>
+        public DOMap DynObjs 
+        { 
+            get
+            {
+                if (m_dynObjs == null)
+                    m_dynObjs = new DOMap();
+
+                return m_dynObjs;
+            }
+
+            set
+            {
+                m_dynObjs = value;
+            }
+        }
         
         /// <value>
         /// Is this a root part?
@@ -348,6 +369,7 @@ namespace OpenSim.Region.Framework.Scenes
             Rezzed = DateTime.UtcNow;
             Description = String.Empty;
             DynAttrs = new DAMap();
+            DynObjs = new DOMap();
 
             // Prims currently only contain a single folder (Contents).  From looking at the Second Life protocol,
             // this appears to have the same UUID (!) as the prim.  If this isn't the case, one can't drag items from