* refactor: Move god related methods in Scene out to a module

4 files changed, 218 insertions, 119 deletions

diff --git a/OpenSim/Region/CoreModules/Avatar/Gods/GodsModule.cs b/OpenSim/Region/CoreModules/Avatar/Gods/GodsModule.cs
new file mode 100644
index 0000000..dfd6c06
--- /dev/null
+++ b/OpenSim/Region/CoreModules/Avatar/Gods/GodsModule.cs
@@ -0,0 +1,150 @@
+/*
+ * 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 System.Collections.Generic;
+using Nini.Config;
+using OpenMetaverse;
+using OpenSim.Framework;
+using OpenSim.Region.Framework.Scenes;
+using OpenSim.Region.Framework.Interfaces;
+
+namespace OpenSim.Region.CoreModules.Avatar.Gods
+{
+    public class GodsModules : IRegionModule, IGodsModule
+    {
+        protected Scene m_scene;
+        protected IDialogModule m_dialogModule;
+        
+        public void Initialise(Scene scene, IConfigSource source)
+        {
+            m_scene = scene;
+            m_dialogModule = m_scene.RequestModuleInterface<IDialogModule>();
+            m_scene.RegisterModuleInterface<IGodsModule>(this);           
+        }
+        
+        public void PostInitialise() {}
+        public void Close() {}
+        public string Name { get { return "Gods Module"; } }
+        public bool IsSharedModule { get { return false; } }
+        
+        public void RequestGodlikePowers(
+            UUID agentID, UUID sessionID, UUID token, bool godLike, IClientAPI controllingClient)
+        {
+            ScenePresence sp = m_scene.GetScenePresence(agentID);
+
+            if (sp != null)
+            {
+                if (godLike == false)
+                {
+                    sp.GrantGodlikePowers(agentID, sessionID, token, godLike);
+                    return;
+                }
+
+                // First check that this is the sim owner
+                if (m_scene.Permissions.IsGod(agentID))
+                {
+                    // Next we check for spoofing.....
+                    UUID testSessionID = sp.ControllingClient.SessionId;
+                    if (sessionID == testSessionID)
+                    {
+                        if (sessionID == controllingClient.SessionId)
+                        {
+                            //m_log.Info("godlike: " + godLike.ToString());
+                            sp.GrantGodlikePowers(agentID, testSessionID, token, godLike);
+                        }
+                    }
+                }
+                else
+                {
+                    m_dialogModule.SendAlertToUser(agentID, "Request for god powers denied");
+                }
+            }
+        }        
+        
+        /// <summary>
+        /// Kicks User specified from the simulator. This logs them off of the grid
+        /// If the client gets the UUID: 44e87126e7944ded05b37c42da3d5cdb it assumes
+        /// that you're kicking it even if the avatar's UUID isn't the UUID that the
+        /// agent is assigned
+        /// </summary>
+        /// <param name="godID">The person doing the kicking</param>
+        /// <param name="sessionID">The session of the person doing the kicking</param>
+        /// <param name="agentID">the person that is being kicked</param>
+        /// <param name="kickflags">This isn't used apparently</param>
+        /// <param name="reason">The message to send to the user after it's been turned into a field</param>
+        public void KickUser(UUID godID, UUID sessionID, UUID agentID, uint kickflags, byte[] reason)
+        {
+            // For some reason the client sends this seemingly hard coded UUID for kicking everyone.   Dun-know.
+            UUID kickUserID = new UUID("44e87126e7944ded05b37c42da3d5cdb");
+            
+            ScenePresence sp = m_scene.GetScenePresence(agentID);
+
+            if (sp != null || agentID == kickUserID)
+            {
+                if (m_scene.Permissions.IsGod(godID))
+                {
+                    if (agentID == kickUserID)
+                    {
+                        m_scene.ClientManager.ForEachClient(
+                            delegate(IClientAPI controller)
+                            {
+                                if (controller.AgentId != godID)
+                                    controller.Kick(Utils.BytesToString(reason));
+                            }
+                        );
+
+                        // This is a bit crude.   It seems the client will be null before it actually stops the thread
+                        // The thread will kill itself eventually :/
+                        // Is there another way to make sure *all* clients get this 'inter region' message?
+                        m_scene.ForEachScenePresence(
+                            delegate(ScenePresence p)
+                            {
+                                if (p.UUID != godID && !p.IsChildAgent)
+                                {
+                                    // Possibly this should really be p.Close() though that method doesn't send a close
+                                    // to the client
+                                    p.ControllingClient.Close(true);
+                                }
+                            }
+                        );
+                    }
+                    else
+                    {
+                        m_scene.SceneGraph.removeUserCount(!sp.IsChildAgent);
+
+                        sp.ControllingClient.Kick(Utils.BytesToString(reason));
+                        sp.ControllingClient.Close(true);
+                    }
+                }
+                else
+                {                  
+                    m_dialogModule.SendAlertToUser(godID, "Kick request denied");
+                }
+            }
+        }
+    }
+}
\ No newline at end of file
diff --git a/OpenSim/Region/Framework/Interfaces/IGodsModule.cs b/OpenSim/Region/Framework/Interfaces/IGodsModule.cs
new file mode 100644
index 0000000..8e94750
--- /dev/null
+++ b/OpenSim/Region/Framework/Interfaces/IGodsModule.cs
@@ -0,0 +1,58 @@
+/*
+ * 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.Framework.Interfaces
+{      
+    /// <summary>
+    /// This interface provides god related methods
+    /// </summary>
+    public interface IGodsModule
+    {
+        /// <summary>
+        /// Handle a request for admin rights
+        /// </summary>
+        /// <param name="agentID"></param>
+        /// <param name="sessionID"></param>
+        /// <param name="token"></param>
+        /// <param name="godLike"></param>
+        /// <param name="controllingClient"></param>
+        void RequestGodlikePowers(UUID agentID, UUID sessionID, UUID token, bool godLike, IClientAPI controllingClient);
+            
+        /// <summary>
+        /// Kicks User specified from the simulator.  This logs them off of the grid.
+        /// </summary>
+        /// <param name="godID">The person doing the kicking</param>
+        /// <param name="sessionID">The session of the person doing the kicking</param>
+        /// <param name="agentID">the person that is being kicked</param>
+        /// <param name="kickflags">This isn't used apparently</param>
+        /// <param name="reason">The message to send to the user after it's been turned into a field</param>
+        void KickUser(UUID godID, UUID sessionID, UUID agentID, uint kickflags, byte[] reason);     
+    }
+}
diff --git a/OpenSim/Region/Framework/Scenes/Scene.cs b/OpenSim/Region/Framework/Scenes/Scene.cs
index 2687422..c9e13ac 100644
--- a/OpenSim/Region/Framework/Scenes/Scene.cs
+++ b/OpenSim/Region/Framework/Scenes/Scene.cs
@@ -1931,9 +1931,7 @@ namespace OpenSim.Region.Framework.Scenes
             client.OnObjectDuplicate += m_sceneGraph.DuplicateObject;
             client.OnObjectDuplicateOnRay += doObjectDuplicateOnRay;
             client.OnUpdatePrimFlags += m_sceneGraph.UpdatePrimFlags;
-            client.OnRequestObjectPropertiesFamily += m_sceneGraph.RequestObjectPropertiesFamily;
-            client.OnRequestGodlikePowers += handleRequestGodlikePowers;
-            client.OnGodKickUser += HandleGodlikeKickUser;
+            client.OnRequestObjectPropertiesFamily += m_sceneGraph.RequestObjectPropertiesFamily;           
             client.OnObjectPermissions += HandleObjectPermissionsUpdate;
             client.OnCreateNewInventoryItem += CreateNewInventoryItem;
             client.OnCreateNewInventoryFolder += HandleCreateInventoryFolder;
@@ -1970,9 +1968,12 @@ namespace OpenSim.Region.Framework.Scenes
             client.OnSetScriptRunning += SetScriptRunning;
             client.OnRegionHandleRequest += RegionHandleRequest;
             client.OnUnackedTerrain += TerrainUnAcked;
-
             client.OnObjectOwner += ObjectOwner;
 
+            IGodsModule godsModule = RequestModuleInterface<IGodsModule>();
+            client.OnGodKickUser += godsModule.KickUser;
+            client.OnRequestGodlikePowers += godsModule.RequestGodlikePowers; 
+
             if (StatsReporter != null)
                 client.OnNetworkStatsUpdate += StatsReporter.AddPacketsFromClientStats;
 
@@ -2658,7 +2659,7 @@ namespace OpenSim.Region.Framework.Scenes
         /// <param name="maxY"></param>
         public void RequestMapBlocks(IClientAPI remoteClient, int minX, int minY, int maxX, int maxY)
         {
-            m_log.InfoFormat("[MAPBLOCK]: {0}-{1}, {2}-{3}", minX, minY, maxX, maxY);
+            m_log.DebugFormat("[MAPBLOCK]: {0}-{1}, {2}-{3}", minX, minY, maxX, maxY);
             m_sceneGridService.RequestMapBlocks(remoteClient, minX, minY, maxX, maxY);
         }
 
@@ -2817,116 +2818,6 @@ namespace OpenSim.Region.Framework.Scenes
 
         #endregion
 
-        #region Alert Methods
-
-        /// <summary>
-        /// Handle a request for admin rights
-        /// </summary>
-        /// <param name="agentID"></param>
-        /// <param name="sessionID"></param>
-        /// <param name="token"></param>
-        /// <param name="controllingClient"></param>
-        public void handleRequestGodlikePowers(UUID agentID, UUID sessionID, UUID token, bool godLike,
-                                               IClientAPI controllingClient)
-        {
-            ScenePresence sp = null;
-
-            lock (m_scenePresences)
-            {
-                // User needs to be logged into this sim
-                m_scenePresences.TryGetValue(agentID, out sp);
-            }
-
-            if (sp != null)
-            {
-                if (godLike == false)
-                {
-                    sp.GrantGodlikePowers(agentID, sessionID, token, godLike);
-                    return;
-                }
-
-                // First check that this is the sim owner
-                if (Permissions.IsGod(agentID))
-                {
-                    // Next we check for spoofing.....
-                    UUID testSessionID = sp.ControllingClient.SessionId;
-                    if (sessionID == testSessionID)
-                    {
-                        if (sessionID == controllingClient.SessionId)
-                        {
-                            //m_log.Info("godlike: " + godLike.ToString());
-                            sp.GrantGodlikePowers(agentID, testSessionID, token, godLike);
-                        }
-                    }
-                }
-                else
-                {
-                    m_dialogModule.SendAlertToUser(agentID, "Request for god powers denied");
-                }
-            }
-        }
-
-        /// <summary>
-        /// Kicks User specified from the simulator. This logs them off of the grid
-        /// If the client gets the UUID: 44e87126e7944ded05b37c42da3d5cdb it assumes
-        /// that you're kicking it even if the avatar's UUID isn't the UUID that the
-        /// agent is assigned
-        /// </summary>
-        /// <param name="godID">The person doing the kicking</param>
-        /// <param name="sessionID">The session of the person doing the kicking</param>
-        /// <param name="agentID">the person that is being kicked</param>
-        /// <param name="kickflags">This isn't used apparently</param>
-        /// <param name="reason">The message to send to the user after it's been turned into a field</param>
-        public void HandleGodlikeKickUser(UUID godID, UUID sessionID, UUID agentID, uint kickflags, byte[] reason)
-        {
-            // For some reason the client sends this seemingly hard coded UUID for kicking everyone.   Dun-know.
-            UUID kickUserID = new UUID("44e87126e7944ded05b37c42da3d5cdb");
-            lock (m_scenePresences)
-            {
-                if (m_scenePresences.ContainsKey(agentID) || agentID == kickUserID)
-                {
-                    if (Permissions.IsGod(godID))
-                    {
-                        if (agentID == kickUserID)
-                        {
-                            ClientManager.ForEachClient(delegate(IClientAPI controller)
-                                                        {
-                                                            if (controller.AgentId != godID)
-                                                                controller.Kick(Utils.BytesToString(reason));
-                                                        }
-                                );
-
-                            // This is a bit crude.   It seems the client will be null before it actually stops the thread
-                            // The thread will kill itself eventually :/
-                            // Is there another way to make sure *all* clients get this 'inter region' message?
-                            ClientManager.ForEachClient(delegate(IClientAPI controller)
-                                                        {
-                                                            ScenePresence p = GetScenePresence(controller.AgentId);
-                                                            bool childagent = p != null && p.IsChildAgent;
-                                                            if (controller.AgentId != godID && !childagent)
-                                                                // Do we really want to kick the initiator of this madness?
-                                                            {
-                                                                controller.Close(true);
-                                                            }
-                                                        }
-                                );
-                        }
-                        else
-                        {
-                            m_sceneGraph.removeUserCount(!m_scenePresences[agentID].IsChildAgent);
-
-                            m_scenePresences[agentID].ControllingClient.Kick(Utils.BytesToString(reason));
-                            m_scenePresences[agentID].ControllingClient.Close(true);
-                        }
-                    }
-                    else
-                    {
-                        m_dialogModule.SendAlertToUser(godID, "Kick request denied");
-                    }
-                }
-            }
-        }
-
         public void HandleObjectPermissionsUpdate(IClientAPI controller, UUID agentID, UUID sessionID, byte field, uint localId, uint mask, byte set)
         {
             // Check for spoofing..  since this is permissions we're talking about here!
@@ -2944,8 +2835,6 @@ namespace OpenSim.Region.Framework.Scenes
             }
         }
 
-        #endregion
-
         /// <summary>
         /// Causes all clients to get a full object update on all of the objects in the scene.
         /// </summary>
@@ -3077,7 +2966,9 @@ namespace OpenSim.Region.Framework.Scenes
                     }
                     else if ((parcel.landData.Flags & (uint)Parcel.ParcelFlags.AllowGroupScripts) != 0)
                     {
-                        if (part.OwnerID == parcel.landData.OwnerID || (parcel.landData.IsGroupOwned && part.GroupID == parcel.landData.GroupID) || Permissions.IsGod(part.OwnerID))
+                        if (part.OwnerID == parcel.landData.OwnerID 
+                            || (parcel.landData.IsGroupOwned && part.GroupID == parcel.landData.GroupID) 
+                            || Permissions.IsGod(part.OwnerID))
                         {
                             return true;
                         }
diff --git a/OpenSim/Region/Framework/Scenes/SceneGraph.cs b/OpenSim/Region/Framework/Scenes/SceneGraph.cs
index 69f5205..d6aca31 100644
--- a/OpenSim/Region/Framework/Scenes/SceneGraph.cs
+++ b/OpenSim/Region/Framework/Scenes/SceneGraph.cs
@@ -696,7 +696,7 @@ namespace OpenSim.Region.Framework.Scenes
             }
         }
 
-        protected internal void removeUserCount(bool TypeRCTF)
+        public void removeUserCount(bool TypeRCTF)
         {
             if (TypeRCTF)
             {