* refactor: Establish DialogModule, move some alert code from Scene to here

OpenSim/Region/Environment/Interfaces/IDialogModule.cs

@@ -0,0 +1,59 @@
+/*
+ * 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;
+using OpenMetaverse;
+
+namespace OpenSim.Region.Environment.Interfaces
+{
+    public interface IDialogModule
+    {
+        /// <summary>
+        /// Send a non-modal alert message to a particular user.
+        /// </summary>
+        /// <param name="agentID"></param>
+        /// <param name="message"></param>
+        void SendAlertToUser(UUID agentID, string message);
+        
+        /// <summary>
+        /// Send an alert message to a particular user.
+        /// </summary>
+        /// <param name="agentID"></param>
+        /// <param name="message"></param>
+        /// <param name="modal"></param>
+        void SendAlertToUser(UUID agentID, string message, bool modal);
+        
+        /// <summary>
+        /// Send an alert message to a particular user.
+        /// </summary>
+        /// <param name="firstName"></param>
+        /// <param name="lastName"></param>
+        /// <param name="message"></param>
+        /// <param name="modal"></param>
+        void SendAlertToUser(string firstName, string lastName, string message, bool modal); 
+    }
+}

OpenSim/Region/Environment/Modules/Avatar/Dialog/DialogModule.cs

@@ -0,0 +1,83 @@
+/*
+ * 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 System.Reflection;
+using log4net;
+using Nini.Config;
+using OpenMetaverse;
+using OpenSim.Framework;
+using OpenSim.Region.Environment.Interfaces;
+using OpenSim.Region.Environment.Scenes;
+
+namespace OpenSim.Region.Environment.Modules.Avatar.Dialog
+{
+    public class DialogModule : IRegionModule, IDialogModule
+    { 
+        //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<IDialogModule>(this);
+        }
+        
+        public void PostInitialise() {}
+        public void Close() {}
+        public string Name { get { return "Dialog Module"; } }
+        public bool IsSharedModule { get { return false; } }
+        
+        public void SendAlertToUser(UUID agentID, string message)
+        {
+            SendAlertToUser(agentID, message, false);
+        }          
+        
+        public void SendAlertToUser(UUID agentID, string message, bool modal)
+        {
+            ScenePresence sp = m_scene.GetScenePresence(agentID);
+            
+            if (sp != null)
+                sp.ControllingClient.SendAgentAlertMessage(message, modal);
+        }   
+        
+        public void SendAlertToUser(string firstName, string lastName, string message, bool modal)
+        {
+            List<ScenePresence> presenceList = m_scene.GetScenePresences();
+
+            foreach (ScenePresence presence in presenceList)
+            {
+                if (presence.Firstname == firstName && presence.Lastname == lastName)
+                {
+                    presence.ControllingClient.SendAgentAlertMessage(message, modal);
+                    break;
+                }
+            }
+        }        
+    }
+}

OpenSim/Region/Environment/Scenes/Scene.cs

@@ -414,7 +414,10 @@ namespace OpenSim.Region.Environment.Scenes
 
         protected virtual void RegisterDefaultSceneEvents()
         {
-            m_eventManager.OnPermissionError += SendPermissionAlert;
+            IDialogModule dm = RequestModuleInterface<IDialogModule>();
+            
+            if (dm != null)
+                m_eventManager.OnPermissionError += dm.SendAlertToUser;
         }
 
         public override string GetSimulatorVersion()
@@ -3429,11 +3432,6 @@ namespace OpenSim.Region.Environment.Scenes
 
         #region Alert Methods
 
-        private void SendPermissionAlert(UUID user, string reason)
-        {
-            SendAlertToUser(user, reason, false);
-        }
-
         /// <summary>
         /// Send an alert messages to all avatars in this scene.
         /// </summary>
@@ -3449,23 +3447,6 @@ namespace OpenSim.Region.Environment.Scenes
             }
         }
 
-        /// <summary>
-        /// Send an alert message to a particular agent.
-        /// </summary>
-        /// <param name="agentID"></param>
-        /// <param name="message"></param>
-        /// <param name="modal"></param>
-        public void SendAlertToUser(UUID agentID, string message, bool modal)
-        {
-            lock (m_scenePresences)
-            {
-                if (m_scenePresences.ContainsKey(agentID))
-                {
-                    m_scenePresences[agentID].ControllingClient.SendAgentAlertMessage(message, modal);
-                }
-            }
-        }
-
         /// <summary>
         /// Handle a request for admin rights
         /// </summary>
@@ -3625,27 +3606,6 @@ namespace OpenSim.Region.Environment.Scenes
             }
         }
 
-        /// <summary>
-        ///
-        /// </summary>
-        /// <param name="firstName"></param>
-        /// <param name="lastName"></param>
-        /// <param name="message"></param>
-        /// <param name="modal"></param>
-        public void SendAlertToUser(string firstName, string lastName, string message, bool modal)
-        {
-            List<ScenePresence> presenceList = GetScenePresences();
-
-            foreach (ScenePresence presence in presenceList)
-            {
-                if (presence.Firstname == firstName && presence.Lastname == lastName)
-                {
-                    presence.ControllingClient.SendAgentAlertMessage(message, modal);
-                    break;
-                }
-            }
-        }
-
         /// <summary>
         /// Handle an alert command from the console.
         /// FIXME: Command parsing code really shouldn't be in this core Scene class.
@@ -3660,8 +3620,13 @@ namespace OpenSim.Region.Environment.Scenes
             }
             else
             {
-                string message = CombineParams(commandParams, 2);
+                IDialogModule dm = RequestModuleInterface<IDialogModule>();
-                SendAlertToUser(commandParams[0], commandParams[1], message, false);
+                
+                if (dm != null)     
+                {
+                    string message = CombineParams(commandParams, 2);
+                    dm.SendAlertToUser(commandParams[0], commandParams[1], message, false);
+                }
             }
         }