* refactor: move gestures code out from Scene into its own module

3 files changed, 155 insertions, 45 deletions

diff --git a/OpenSim/Region/Environment/Interfaces/IGesturesModule.cs b/OpenSim/Region/Environment/Interfaces/IGesturesModule.cs
new file mode 100644
index 0000000..a070f62
--- /dev/null
+++ b/OpenSim/Region/Environment/Interfaces/IGesturesModule.cs
@@ -0,0 +1,50 @@
+/*
+ * 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 OpenMetaverse;
+using OpenSim.Framework;
+
+namespace OpenSim.Region.Environment
+{
+    public interface IGesturesModule
+    {
+        /// <summary>
+        /// Active a gesture
+        /// </summary>
+        /// <param name="client"></param>
+        /// <param name="assetId"></param>
+        /// <param name="gestureId"></param>
+        void ActivateGesture(IClientAPI client, UUID assetId, UUID gestureId);
+        
+        /// <summary>
+        /// Deactivate a gesture
+        /// </summary>
+        /// <param name="client"></param>
+        /// <param name="gestureId"></param>
+        void DeactivateGesture(IClientAPI client, UUID gestureId);
+    }
+}
diff --git a/OpenSim/Region/Environment/Modules/Avatar/Gestures/GesturesModule.cs b/OpenSim/Region/Environment/Modules/Avatar/Gestures/GesturesModule.cs
new file mode 100644
index 0000000..5f0f4f9
--- /dev/null
+++ b/OpenSim/Region/Environment/Modules/Avatar/Gestures/GesturesModule.cs
@@ -0,0 +1,97 @@
+/*
+ * 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 log4net;
+using Nini.Config;
+using OpenMetaverse;
+using OpenSim.Framework;
+using OpenSim.Framework.Communications;
+using OpenSim.Framework.Communications.Cache;
+using OpenSim.Region.Environment.Interfaces;
+using OpenSim.Region.Environment.Scenes;
+using System.Reflection;
+
+namespace OpenSim.Region.Environment.Modules.Avatar.Gestures
+{
+    public class GesturesModule : IRegionModule, IGesturesModule
+    { 
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+        
+        protected Scene m_scene;
+        
+        public void Initialise(Scene scene, IConfigSource source)
+        {
+            m_scene = scene;
+            m_scene.RegisterModuleInterface<IGesturesModule>(this);
+        }
+        
+        public void PostInitialise() {}
+        public void Close() {}
+        public string Name { get { return "Gestures Module"; } }
+        public bool IsSharedModule { get { return false; } }
+        
+        public virtual void ActivateGesture(IClientAPI client, UUID assetId, UUID gestureId)
+        {
+            CachedUserInfo userInfo = m_scene.CommsManager.UserProfileCacheService.GetUserDetails(client.AgentId);
+
+            if (userInfo != null)
+            {
+                InventoryItemBase item = userInfo.RootFolder.FindItem(gestureId);
+                if (item != null)
+                {
+                    item.Flags = 1;
+                    userInfo.UpdateItem(item);
+                }
+                else 
+                    m_log.ErrorFormat(
+                        "[GESTURES]: Unable to find gesture to activate {0} for {1}", gestureId, client.Name);
+            }
+            else 
+                m_log.ErrorFormat("[GESTURES]: Unable to find user {0}", client.Name);
+        }
+
+        public virtual void DeactivateGesture(IClientAPI client,  UUID gestureId)
+        {
+            CachedUserInfo userInfo = m_scene.CommsManager.UserProfileCacheService.GetUserDetails(client.AgentId);
+
+            if (userInfo != null)
+            {
+                InventoryItemBase item = userInfo.RootFolder.FindItem(gestureId);
+                if (item != null)
+                {
+                    item.Flags = 0;
+                    userInfo.UpdateItem(item);
+                }
+                else 
+                    m_log.ErrorFormat(
+                        "[GESTURES]: Unable to find gesture to deactivate {0} for {1}", gestureId, client.Name);
+            }
+            else 
+                m_log.ErrorFormat("[GESTURES]: Unable to find user {0}", client.Name);
+        }        
+    }
+}
\ No newline at end of file
diff --git a/OpenSim/Region/Environment/Scenes/Scene.cs b/OpenSim/Region/Environment/Scenes/Scene.cs
index 7a4c385..72748b6 100644
--- a/OpenSim/Region/Environment/Scenes/Scene.cs
+++ b/OpenSim/Region/Environment/Scenes/Scene.cs
@@ -1778,7 +1778,7 @@ namespace OpenSim.Region.Environment.Scenes
             return sceneObject;
         }
 
-        void AdaptTree(ref PrimitiveBaseShape tree)
+        protected void AdaptTree(ref PrimitiveBaseShape tree)
         {
             // Tree size has to be adapted depending on its type
             switch ((Tree)tree.State)
@@ -2450,9 +2450,13 @@ namespace OpenSim.Region.Environment.Scenes
             client.OnRegionHandleRequest += RegionHandleRequest;
             client.OnUnackedTerrain += TerrainUnAcked;
 
-            //Gesture
-            client.OnActivateGesture += ActivateGesture;
-            client.OnDeactivateGesture += DeactivateGesture;
+            IGesturesModule gesturesModule = RequestModuleInterface<IGesturesModule>();            
+            if (gesturesModule != null)
+            {
+                client.OnActivateGesture += gesturesModule.ActivateGesture;
+                client.OnDeactivateGesture += gesturesModule.DeactivateGesture;
+            }
+            
             //sound
             client.OnSoundTrigger += SoundTrigger;
 
@@ -2478,47 +2482,6 @@ namespace OpenSim.Region.Environment.Scenes
             
         }
 
-        // Gesture
-        public virtual void ActivateGesture(IClientAPI client,  UUID assetId, UUID gestureId)
-        {
-          //  UserProfileCacheService User = CommsManager.SecureInventoryService.UpdateItem(gestureid, agentID);
-            CachedUserInfo userInfo = CommsManager.UserProfileCacheService.GetUserDetails(client.AgentId);
-
-            if (userInfo != null)
-            {
-                InventoryItemBase item = userInfo.RootFolder.FindItem(gestureId);
-                if (item != null)
-                {
-                    item.Flags = 1;
-                    userInfo.UpdateItem(item);
-                }
-                else m_log.Error("Unable to find gesture");
-            }
-            else m_log.Error("Gesture : Unable to find user ");
-
-            m_log.DebugFormat("Asset : {0} gesture :{1}", gestureId.ToString(), assetId.ToString());
-        }
-
-        public virtual void DeactivateGesture(IClientAPI client,  UUID gestureId)
-        {
-            //  UserProfileCacheService User = CommsManager.SecureInventoryService.UpdateItem(gestureid, agentID);
-            CachedUserInfo userInfo = CommsManager.UserProfileCacheService.GetUserDetails(client.AgentId);
-
-            if (userInfo != null)
-            {
-                InventoryItemBase item = userInfo.RootFolder.FindItem(gestureId);
-                if (item != null)
-                {
-                    item.Flags = 0;
-                    userInfo.UpdateItem(item);
-                }
-                else m_log.Error("Unable to find gesture");
-            }
-            else m_log.Error("Gesture : Unable to find user ");
-
-            m_log.DebugFormat("gesture : {0} ", gestureId.ToString());
-        }
-
         /// <summary>
         /// Teleport an avatar to their home region
         /// </summary>