2 files changed, 342 insertions, 108 deletions

diff --git a/OpenSim/Region/CoreModules/Avatar/Chat/Tests/ChatModuleTests.cs b/OpenSim/Region/CoreModules/Avatar/Chat/Tests/ChatModuleTests.cs
new file mode 100644
index 0000000..7b8c418
--- /dev/null
+++ b/OpenSim/Region/CoreModules/Avatar/Chat/Tests/ChatModuleTests.cs
@@ -0,0 +1,286 @@
+/*
+ * 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 log4net.Config;
+using Nini.Config;
+using NUnit.Framework;
+using OpenMetaverse;
+using OpenSim.Framework;
+using OpenSim.Framework.Servers;
+using OpenSim.Framework.Servers.HttpServer;
+using OpenSim.Region.CoreModules.Avatar.Chat;
+using OpenSim.Region.CoreModules.Framework;
+using OpenSim.Region.CoreModules.Framework.EntityTransfer;
+using OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation;
+using OpenSim.Region.Framework.Scenes;
+using OpenSim.Services.Interfaces;
+using OpenSim.Tests.Common;
+using OpenSim.Tests.Common.Mock;
+
+namespace OpenSim.Region.CoreModules.Avatar.Chat.Tests
+{
+    [TestFixture]
+    public class ChatModuleTests : OpenSimTestCase
+    {  
+        [TestFixtureSetUp]
+        public void FixtureInit()
+        {
+            // Don't allow tests to be bamboozled by asynchronous events.  Execute everything on the same thread.
+            // We must do this here so that child agent positions are updated in a predictable manner.
+            Util.FireAndForgetMethod = FireAndForgetMethod.RegressionTest;
+        }
+
+        [TestFixtureTearDown]
+        public void TearDown()
+        {
+            // We must set this back afterwards, otherwise later tests will fail since they're expecting multiple
+            // threads.  Possibly, later tests should be rewritten so none of them require async stuff (which regression
+            // tests really shouldn't).
+            Util.FireAndForgetMethod = Util.DefaultFireAndForgetMethod;
+        }
+
+        private void SetupNeighbourRegions(TestScene sceneA, TestScene sceneB)
+        {            
+            // XXX: HTTP server is not (and should not be) necessary for this test, though it's absence makes the 
+            // CapabilitiesModule complain when it can't set up HTTP endpoints.
+            //            BaseHttpServer httpServer = new BaseHttpServer(99999);
+            //            MainServer.AddHttpServer(httpServer);
+            //            MainServer.Instance = httpServer;
+
+            // We need entity transfer modules so that when sp2 logs into the east region, the region calls 
+            // EntityTransferModuleto set up a child agent on the west region.
+            // XXX: However, this is not an entity transfer so is misleading.
+            EntityTransferModule etmA = new EntityTransferModule();
+            EntityTransferModule etmB = new EntityTransferModule();
+            LocalSimulationConnectorModule lscm = new LocalSimulationConnectorModule();
+
+            IConfigSource config = new IniConfigSource();
+            config.AddConfig("Chat");
+            IConfig modulesConfig = config.AddConfig("Modules");
+            modulesConfig.Set("EntityTransferModule", etmA.Name);
+            modulesConfig.Set("SimulationServices", lscm.Name);
+
+            SceneHelpers.SetupSceneModules(new Scene[] { sceneA, sceneB }, config, lscm);
+            SceneHelpers.SetupSceneModules(sceneA, config, new CapabilitiesModule(), etmA, new ChatModule());           
+            SceneHelpers.SetupSceneModules(sceneB, config, new CapabilitiesModule(), etmB, new ChatModule());
+        }
+
+        /// <summary>
+        /// Tests chat between neighbour regions on the east-west axis
+        /// </summary>
+        /// <remarks>
+        /// Really, this is a combination of a child agent position update test and a chat range test.  These need
+        /// to be separated later on.
+        /// </remarks>
+        [Test]
+        public void TestInterRegionChatDistanceEastWest()
+        {
+            TestHelpers.InMethod();
+//            TestHelpers.EnableLogging();
+
+            UUID sp1Uuid = TestHelpers.ParseTail(0x11);
+            UUID sp2Uuid = TestHelpers.ParseTail(0x12);
+
+            Vector3 sp1Position = new Vector3(6, 128, 20);
+            Vector3 sp2Position = new Vector3(250, 128, 20);
+
+            SceneHelpers sh = new SceneHelpers();
+            TestScene sceneWest = sh.SetupScene("sceneWest", TestHelpers.ParseTail(0x1), 1000, 1000);            
+            TestScene sceneEast = sh.SetupScene("sceneEast", TestHelpers.ParseTail(0x2), 1001, 1000);            
+
+            SetupNeighbourRegions(sceneWest, sceneEast);
+
+            ScenePresence sp1 = SceneHelpers.AddScenePresence(sceneEast, sp1Uuid);
+            TestClient sp1Client = (TestClient)sp1.ControllingClient;
+
+            // If we don't set agents to flying, test will go wrong as they instantly fall to z = 0.
+            // TODO: May need to create special complete no-op test physics module rather than basic physics, since
+            // physics is irrelevant to this test.
+            sp1.Flying = true;
+
+            // When sp1 logs in to sceneEast, it sets up a child agent in sceneWest and informs the sp2 client to 
+            // make the connection.  For this test, will simplify this chain by making the connection directly.
+            ScenePresence sp1Child = SceneHelpers.AddChildScenePresence(sceneWest, sp1Uuid);
+            TestClient sp1ChildClient = (TestClient)sp1Child.ControllingClient;
+
+            sp1.AbsolutePosition = sp1Position;                
+
+            ScenePresence sp2 = SceneHelpers.AddScenePresence(sceneWest, sp2Uuid);
+            TestClient sp2Client = (TestClient)sp2.ControllingClient;
+            sp2.Flying = true;
+
+            ScenePresence sp2Child = SceneHelpers.AddChildScenePresence(sceneEast, sp2Uuid);
+            TestClient sp2ChildClient = (TestClient)sp2Child.ControllingClient;
+
+            sp2.AbsolutePosition = sp2Position;           
+
+            // We must update the scenes in order to make the root new root agents trigger position updates in their
+            // children.
+            sceneWest.Update(1);
+            sceneEast.Update(1);
+
+            // Check child positions are correct.
+            Assert.AreEqual(
+                new Vector3(sp1Position.X + sceneEast.RegionInfo.RegionSizeX, sp1Position.Y, sp1Position.Z), 
+                sp1ChildClient.SceneAgent.AbsolutePosition);
+
+            Assert.AreEqual(
+                new Vector3(sp2Position.X - sceneWest.RegionInfo.RegionSizeX, sp2Position.Y, sp2Position.Z), 
+                sp2ChildClient.SceneAgent.AbsolutePosition);
+
+            string receivedSp1ChatMessage = "";
+            string receivedSp2ChatMessage = "";
+
+            sp1ChildClient.OnReceivedChatMessage 
+                += (message, type, fromPos, fromName, fromAgentID, ownerID, source, audible) => receivedSp1ChatMessage = message;
+            sp2ChildClient.OnReceivedChatMessage 
+                += (message, type, fromPos, fromName, fromAgentID, ownerID, source, audible) => receivedSp2ChatMessage = message;
+
+            TestUserInRange(sp1Client, "ello darling", ref receivedSp2ChatMessage);
+            TestUserInRange(sp2Client, "fantastic cats", ref receivedSp1ChatMessage);
+
+            sp1Position = new Vector3(30, 128, 20);
+            sp1.AbsolutePosition = sp1Position;
+            sceneEast.Update(1);
+
+            // Check child position is correct.
+            Assert.AreEqual(
+                new Vector3(sp1Position.X + sceneEast.RegionInfo.RegionSizeX, sp1Position.Y, sp1Position.Z), 
+                sp1ChildClient.SceneAgent.AbsolutePosition);
+
+            TestUserOutOfRange(sp1Client, "beef", ref receivedSp2ChatMessage);
+            TestUserOutOfRange(sp2Client, "lentils", ref receivedSp1ChatMessage);
+        }
+
+        /// <summary>
+        /// Tests chat between neighbour regions on the north-south axis
+        /// </summary>
+        /// <remarks>
+        /// Really, this is a combination of a child agent position update test and a chat range test.  These need
+        /// to be separated later on.
+        /// </remarks>
+        [Test]
+        public void TestInterRegionChatDistanceNorthSouth()
+        {
+            TestHelpers.InMethod();
+            //            TestHelpers.EnableLogging();
+
+            UUID sp1Uuid = TestHelpers.ParseTail(0x11);
+            UUID sp2Uuid = TestHelpers.ParseTail(0x12);
+
+            Vector3 sp1Position = new Vector3(128, 250, 20);
+            Vector3 sp2Position = new Vector3(128, 6, 20);
+
+            SceneHelpers sh = new SceneHelpers();
+            TestScene sceneNorth = sh.SetupScene("sceneNorth", TestHelpers.ParseTail(0x1), 1000, 1000);            
+            TestScene sceneSouth = sh.SetupScene("sceneSouth", TestHelpers.ParseTail(0x2), 1000, 1001);            
+
+            SetupNeighbourRegions(sceneNorth, sceneSouth);
+
+            ScenePresence sp1 = SceneHelpers.AddScenePresence(sceneNorth, sp1Uuid);
+            TestClient sp1Client = (TestClient)sp1.ControllingClient;
+
+            // If we don't set agents to flying, test will go wrong as they instantly fall to z = 0.
+            // TODO: May need to create special complete no-op test physics module rather than basic physics, since
+            // physics is irrelevant to this test.
+            sp1.Flying = true;
+
+            // When sp1 logs in to sceneEast, it sets up a child agent in sceneNorth and informs the sp2 client to 
+            // make the connection.  For this test, will simplify this chain by making the connection directly.
+            ScenePresence sp1Child = SceneHelpers.AddChildScenePresence(sceneSouth, sp1Uuid);
+            TestClient sp1ChildClient = (TestClient)sp1Child.ControllingClient;
+
+            sp1.AbsolutePosition = sp1Position;                
+
+            ScenePresence sp2 = SceneHelpers.AddScenePresence(sceneSouth, sp2Uuid);
+            TestClient sp2Client = (TestClient)sp2.ControllingClient;
+            sp2.Flying = true;
+
+            ScenePresence sp2Child = SceneHelpers.AddChildScenePresence(sceneNorth, sp2Uuid);
+            TestClient sp2ChildClient = (TestClient)sp2Child.ControllingClient;
+
+            sp2.AbsolutePosition = sp2Position;           
+
+            // We must update the scenes in order to make the root new root agents trigger position updates in their
+            // children.
+            sceneNorth.Update(1);
+            sceneSouth.Update(1);
+
+            // Check child positions are correct.
+            Assert.AreEqual(
+                new Vector3(sp1Position.X, sp1Position.Y - sceneNorth.RegionInfo.RegionSizeY, sp1Position.Z), 
+                sp1ChildClient.SceneAgent.AbsolutePosition);
+
+            Assert.AreEqual(
+                new Vector3(sp2Position.X, sp2Position.Y + sceneSouth.RegionInfo.RegionSizeY, sp2Position.Z), 
+                sp2ChildClient.SceneAgent.AbsolutePosition);
+
+            string receivedSp1ChatMessage = "";
+            string receivedSp2ChatMessage = "";
+
+            sp1ChildClient.OnReceivedChatMessage 
+                += (message, type, fromPos, fromName, fromAgentID, ownerID, source, audible) => receivedSp1ChatMessage = message;
+            sp2ChildClient.OnReceivedChatMessage 
+                += (message, type, fromPos, fromName, fromAgentID, ownerID, source, audible) => receivedSp2ChatMessage = message;
+
+            TestUserInRange(sp1Client, "ello darling", ref receivedSp2ChatMessage);
+            TestUserInRange(sp2Client, "fantastic cats", ref receivedSp1ChatMessage);
+
+            sp1Position = new Vector3(30, 128, 20);
+            sp1.AbsolutePosition = sp1Position;
+            sceneNorth.Update(1);
+
+            // Check child position is correct.
+            Assert.AreEqual(
+                new Vector3(sp1Position.X, sp1Position.Y - sceneNorth.RegionInfo.RegionSizeY, sp1Position.Z), 
+                sp1ChildClient.SceneAgent.AbsolutePosition);
+
+            TestUserOutOfRange(sp1Client, "beef", ref receivedSp2ChatMessage);
+            TestUserOutOfRange(sp2Client, "lentils", ref receivedSp1ChatMessage);
+        }
+    
+        private void TestUserInRange(TestClient speakClient, string testMessage, ref string receivedMessage)
+        {
+            receivedMessage = "";
+
+            speakClient.Chat(0, ChatTypeEnum.Say, testMessage);
+
+            Assert.AreEqual(testMessage, receivedMessage);
+        }
+
+        private void TestUserOutOfRange(TestClient speakClient, string testMessage, ref string receivedMessage)
+        {
+            receivedMessage = "";
+
+            speakClient.Chat(0, ChatTypeEnum.Say, testMessage);
+
+            Assert.AreNotEqual(testMessage, receivedMessage);
+        }
+    }
+}
\ No newline at end of file
diff --git a/OpenSim/Region/CoreModules/Avatar/InstantMessage/MessageTransferModule.cs b/OpenSim/Region/CoreModules/Avatar/InstantMessage/MessageTransferModule.cs
index 7aa7123..2462ff8 100644
--- a/OpenSim/Region/CoreModules/Avatar/InstantMessage/MessageTransferModule.cs
+++ b/OpenSim/Region/CoreModules/Avatar/InstantMessage/MessageTransferModule.cs
@@ -428,7 +428,7 @@ namespace OpenSim.Region.CoreModules.Avatar.InstantMessage
         /// <summary>
         /// delegate for sending a grid instant message asynchronously
         /// </summary>
-        public delegate void GridInstantMessageDelegate(GridInstantMessage im, MessageResultNotification result, UUID prevRegionID);
+        public delegate void GridInstantMessageDelegate(GridInstantMessage im, MessageResultNotification result);
 
         protected virtual void GridInstantMessageCompleted(IAsyncResult iar)
         {
@@ -442,138 +442,87 @@ namespace OpenSim.Region.CoreModules.Avatar.InstantMessage
         {
             GridInstantMessageDelegate d = SendGridInstantMessageViaXMLRPCAsync;
 
-            d.BeginInvoke(im, result, UUID.Zero, GridInstantMessageCompleted, d);
+            d.BeginInvoke(im, result, GridInstantMessageCompleted, d);
         }
 
         /// <summary>
-        /// Recursive SendGridInstantMessage over XMLRPC method.
-        /// This is called from within a dedicated thread.
-        /// The first time this is called, prevRegionHandle will be 0 Subsequent times this is called from 
-        /// itself, prevRegionHandle will be the last region handle that we tried to send.
-        /// If the handles are the same, we look up the user's location using the grid.
-        /// If the handles are still the same, we end.  The send failed.
+        /// Internal SendGridInstantMessage over XMLRPC method.
         /// </summary>
-        /// <param name="prevRegionHandle">
-        /// Pass in 0 the first time this method is called.  It will be called recursively with the last 
-        /// regionhandle tried
-        /// </param>
-        protected virtual void SendGridInstantMessageViaXMLRPCAsync(GridInstantMessage im, MessageResultNotification result, UUID prevRegionID)
+        /// <remarks>
+        /// This is called from within a dedicated thread.
+        /// </remarks>
+        private void SendGridInstantMessageViaXMLRPCAsync(GridInstantMessage im, MessageResultNotification result)
         {
             UUID toAgentID = new UUID(im.toAgentID);
-
-            PresenceInfo upd = null;
-
-            bool lookupAgent = false;
+            UUID regionID;
+            bool needToLookupAgent;
 
             lock (m_UserRegionMap)
+                needToLookupAgent = !m_UserRegionMap.TryGetValue(toAgentID, out regionID);
+
+            while (true)
             {
-                if (m_UserRegionMap.ContainsKey(toAgentID))
+                if (needToLookupAgent)
                 {
-                    upd = new PresenceInfo();
-                    upd.RegionID = m_UserRegionMap[toAgentID];
+                    PresenceInfo[] presences = PresenceService.GetAgents(new string[] { toAgentID.ToString() }); 
 
-                    // We need to compare the current regionhandle with the previous region handle
-                    // or the recursive loop will never end because it will never try to lookup the agent again
-                    if (prevRegionID == upd.RegionID)
-                    {
-                        lookupAgent = true;
-                    }
-                }
-                else
-                {
-                    lookupAgent = true;
-                }
-            }
-            
+                    UUID foundRegionID = UUID.Zero;
 
-            // Are we needing to look-up an agent?
-            if (lookupAgent)
-            {
-                // Non-cached user agent lookup.
-                PresenceInfo[] presences = PresenceService.GetAgents(new string[] { toAgentID.ToString() }); 
-                if (presences != null && presences.Length > 0)
-                {
-                    foreach (PresenceInfo p in presences)
+                    if (presences != null)
                     {
-                        if (p.RegionID != UUID.Zero)
+                        foreach (PresenceInfo p in presences)
                         {
-                            upd = p;
-                            break;
+                            if (p.RegionID != UUID.Zero)
+                            {
+                                foundRegionID = p.RegionID;
+                                break;
+                            }
                         }
                     }
-                }
 
-                if (upd != null)
-                {
-                    // check if we've tried this before..
-                    // This is one way to end the recursive loop
-                    //
-                    if (upd.RegionID == prevRegionID)
-                    {
-                        // m_log.Error("[GRID INSTANT MESSAGE]: Unable to deliver an instant message");
-                        HandleUndeliverableMessage(im, result);
-                        return;
-                    }
+                    // If not found or the found region is the same as the last lookup, then message is undeliverable
+                    if (foundRegionID == UUID.Zero || foundRegionID == regionID)
+                        break;
+                    else
+                        regionID = foundRegionID;
                 }
-                else
+
+                GridRegion reginfo = m_Scenes[0].GridService.GetRegionByUUID(m_Scenes[0].RegionInfo.ScopeID, regionID);
+                if (reginfo == null)
                 {
-                    // m_log.Error("[GRID INSTANT MESSAGE]: Unable to deliver an instant message");
-                    HandleUndeliverableMessage(im, result);
-                    return;
+                    m_log.WarnFormat("[GRID INSTANT MESSAGE]: Unable to find region {0}", regionID);
+                    break;
                 }
-            }
 
-            if (upd != null)
-            {
-                GridRegion reginfo = m_Scenes[0].GridService.GetRegionByUUID(m_Scenes[0].RegionInfo.ScopeID,
-                    upd.RegionID);
-                if (reginfo != null)
+                // Try to send the message to the agent via the retrieved region.
+                Hashtable msgdata = ConvertGridInstantMessageToXMLRPC(im);
+                msgdata["region_handle"] = 0;
+                bool imresult = doIMSending(reginfo, msgdata);
+
+                // If the message delivery was successful, then cache the entry.
+                if (imresult)
                 {
-                    Hashtable msgdata = ConvertGridInstantMessageToXMLRPC(im);
-                    // Not actually used anymore, left in for compatibility
-                    // Remove at next interface change
-                    //
-                    msgdata["region_handle"] = 0;
-                    bool imresult = doIMSending(reginfo, msgdata);
-                    if (imresult)
-                    {
-                        // IM delivery successful, so store the Agent's location in our local cache.
-                        lock (m_UserRegionMap)
-                        {
-                            if (m_UserRegionMap.ContainsKey(toAgentID))
-                            {
-                                m_UserRegionMap[toAgentID] = upd.RegionID;
-                            }
-                            else
-                            {
-                                m_UserRegionMap.Add(toAgentID, upd.RegionID);
-                            }
-                        }
-                        result(true);
-                    }
-                    else
+                    lock (m_UserRegionMap)
                     {
-                        // try again, but lookup user this time.
-                        // Warning, this must call the Async version
-                        // of this method or we'll be making thousands of threads
-                        // The version within the spawned thread is SendGridInstantMessageViaXMLRPCAsync
-                        // The version that spawns the thread is SendGridInstantMessageViaXMLRPC
-
-                        // This is recursive!!!!!
-                        SendGridInstantMessageViaXMLRPCAsync(im, result,
-                                upd.RegionID);
+                        m_UserRegionMap[toAgentID] = regionID;
                     }
+                    result(true);
+                    return;
                 }
-                else
-                {
-                    m_log.WarnFormat("[GRID INSTANT MESSAGE]: Unable to find region {0}", upd.RegionID);
-                    HandleUndeliverableMessage(im, result);
-                }
-            }
-            else
-            {
-                HandleUndeliverableMessage(im, result);
+
+                // If we reach this point in the first iteration of the while, then we may have unsuccessfully tried
+                // to use a locally cached region ID.  All subsequent attempts need to lookup agent details from
+                // the presence service.
+                needToLookupAgent = true;
             }
+
+            // If we reached this point then the message was not deliverable.  Remove the bad cache entry and 
+            // signal the delivery failure.
+            lock (m_UserRegionMap)
+                m_UserRegionMap.Remove(toAgentID);
+
+            // m_log.Error("[GRID INSTANT MESSAGE]: Unable to deliver an instant message");
+            HandleUndeliverableMessage(im, result);
         }
 
         /// <summary>
@@ -584,7 +533,6 @@ namespace OpenSim.Region.CoreModules.Avatar.InstantMessage
         /// <returns>Bool if the message was successfully delivered at the other side.</returns>
         protected virtual bool doIMSending(GridRegion reginfo, Hashtable xmlrpcdata)
         {
-
             ArrayList SendParams = new ArrayList();
             SendParams.Add(xmlrpcdata);
             XmlRpcRequest GridReq = new XmlRpcRequest("grid_instant_message", SendParams);