Merge branch 'master' into varregion

5 files changed, 114 insertions, 209 deletions

diff --git a/OpenSim/Region/Framework/Interfaces/IEntityTransferModule.cs b/OpenSim/Region/Framework/Interfaces/IEntityTransferModule.cs
index 966916a..709d8fc 100644
--- a/OpenSim/Region/Framework/Interfaces/IEntityTransferModule.cs
+++ b/OpenSim/Region/Framework/Interfaces/IEntityTransferModule.cs
@@ -47,13 +47,33 @@ namespace OpenSim.Region.Framework.Interfaces
         /// The handle of the destination region.  If it's the same as the region currently
         /// occupied by the agent then the teleport will be within that region.
         /// </param>
+        /// <param name='agent'></param>
+        /// <param name='regionHandle'></param>
         /// <param name='position'></param>
         /// <param name='lookAt'></param>
         /// <param name='teleportFlags'></param>
         void Teleport(ScenePresence agent, ulong regionHandle, Vector3 position, Vector3 lookAt, uint teleportFlags);
 
+        /// <summary>
+        /// Teleports the agent for the given client to their home destination.
+        /// </summary>
+        /// <param name='id'></param>
+        /// <param name='client'></param>
         bool TeleportHome(UUID id, IClientAPI client);
 
+        /// <summary>
+        /// Teleport an agent directly to a given region without checking whether the region should be substituted.
+        /// </summary>
+        /// <remarks>
+        /// Please use Teleport() instead unless you know exactly what you're doing.
+        /// Do not use for same region teleports.
+        /// </remarks>
+        /// <param name='sp'></param>
+        /// <param name='reg'></param>
+        /// <param name='finalDestination'>/param>
+        /// <param name='position'></param>
+        /// <param name='lookAt'></param>
+        /// <param name='teleportFlags'></param>
         void DoTeleport(ScenePresence sp, GridRegion reg, GridRegion finalDestination,
             Vector3 position, Vector3 lookAt, uint teleportFlags);
 
diff --git a/OpenSim/Region/Framework/Interfaces/IInterregionComms.cs b/OpenSim/Region/Framework/Interfaces/IInterregionComms.cs
deleted file mode 100644
index 2d6287f..0000000
--- a/OpenSim/Region/Framework/Interfaces/IInterregionComms.cs
+++ /dev/null
@@ -1,111 +0,0 @@
-/*
- * 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 OpenMetaverse;
-using OpenSim.Framework;
-using OpenSim.Region.Framework.Scenes;
-
-namespace OpenSim.Region.Framework.Interfaces
-{
-    public delegate bool ChildAgentUpdateReceived(AgentData data);
-
-    public interface IInterregionCommsOut
-    {
-        #region Agents
-
-        bool SendCreateChildAgent(ulong regionHandle, AgentCircuitData aCircuit, uint teleportFlags, out string reason);
-
-        /// <summary>
-        /// Full child agent update.
-        /// </summary>
-        /// <param name="regionHandle"></param>
-        /// <param name="data"></param>
-        /// <returns></returns>
-        bool SendChildAgentUpdate(ulong regionHandle, AgentData data);
-
-        /// <summary>
-        /// Short child agent update, mostly for position.
-        /// </summary>
-        /// <param name="regionHandle"></param>
-        /// <param name="data"></param>
-        /// <returns></returns>
-        bool SendChildAgentUpdate(ulong regionHandle, AgentPosition data);
-
-        bool SendRetrieveRootAgent(ulong regionHandle, UUID id, out IAgentData agent);
-
-        /// <summary>
-        /// Message from receiving region to departing region, telling it got contacted by the client.
-        /// When sent over REST, it invokes the opaque uri.
-        /// </summary>
-        /// <param name="regionHandle"></param>
-        /// <param name="id"></param>
-        /// <param name="uri"></param>
-        /// <returns></returns>
-        bool SendReleaseAgent(ulong regionHandle, UUID id, string uri);
-
-        /// <summary>
-        /// Close agent.
-        /// </summary>
-        /// <param name="regionHandle"></param>
-        /// <param name="id"></param>
-        /// <returns></returns>
-        bool SendCloseAgent(ulong regionHandle, UUID id);
-
-        #endregion Agents
-
-        #region Objects
-
-        /// <summary>
-        /// Create an object in the destination region. This message is used primarily for prim crossing.
-        /// </summary>
-        /// <param name="regionHandle"></param>
-        /// <param name="sog"></param>
-        /// <param name="isLocalCall"></param>
-        /// <returns></returns>
-        bool SendCreateObject(ulong regionHandle, SceneObjectGroup sog, bool isLocalCall);
-
-        /// <summary>
-        /// Create an object from the user's inventory in the destination region. 
-        /// This message is used primarily by clients.
-        /// </summary>
-        /// <param name="regionHandle"></param>
-        /// <param name="userID"></param>
-        /// <param name="itemID"></param>
-        /// <returns></returns>
-        bool SendCreateObject(ulong regionHandle, UUID userID, UUID itemID);
-
-        #endregion Objects
-
-    }
-
-    // This may not be needed, but having it here for now.
-    public interface IInterregionCommsIn
-    {
-        event ChildAgentUpdateReceived OnChildAgentUpdate;
-    }
-
-}
diff --git a/OpenSim/Region/Framework/Scenes/Scene.cs b/OpenSim/Region/Framework/Scenes/Scene.cs
index d8a4ed1..aee621f 100644
--- a/OpenSim/Region/Framework/Scenes/Scene.cs
+++ b/OpenSim/Region/Framework/Scenes/Scene.cs
@@ -4389,18 +4389,6 @@ namespace OpenSim.Region.Framework.Scenes
             return sp;
         }
 
-        public virtual bool IncomingRetrieveRootAgent(UUID id, out IAgentData agent)
-        {
-            agent = null;
-            ScenePresence sp = GetScenePresence(id);
-            if ((sp != null) && (!sp.IsChildAgent))
-            {
-                sp.IsChildAgent = true;
-                return sp.CopyAgent(out agent);
-            }
-
-            return false;
-        }
         /// <summary>
         /// Authenticated close (via network)
         /// </summary>
diff --git a/OpenSim/Region/Framework/Scenes/ScenePresence.cs b/OpenSim/Region/Framework/Scenes/ScenePresence.cs
index d2c7c76..b4274ba 100644
--- a/OpenSim/Region/Framework/Scenes/ScenePresence.cs
+++ b/OpenSim/Region/Framework/Scenes/ScenePresence.cs
@@ -110,6 +110,16 @@ namespace OpenSim.Region.Framework.Scenes
             }
         }
 
+        /// <summary>
+        /// This exists to prevent race conditions between two CompleteMovement threads if the simulator is slow and
+        /// the viewer fires these in quick succession.
+        /// </summary>
+        /// <remarks>
+        /// TODO: The child -> agent transition should be folded into LifecycleState and the CompleteMovement 
+        /// regulation done there.
+        /// </remarks>
+        private object m_completeMovementLock = new object();
+
 //        private static readonly byte[] DEFAULT_TEXTURE = AvatarAppearance.GetDefaultTexture().GetBytes();
         private static readonly Array DIR_CONTROL_FLAGS = Enum.GetValues(typeof(Dir_ControlFlags));
         private static readonly Vector3 HEAD_ADJUSTMENT = new Vector3(0f, 0f, 0.3f);
@@ -980,6 +990,7 @@ namespace OpenSim.Region.Framework.Scenes
         /// <summary>
         /// Turns a child agent into a root agent.
         /// </summary>
+        /// <remarks>
         /// Child agents are logged into neighbouring sims largely to observe changes.  Root agents exist when the
         /// avatar is actual in the sim.  They can perform all actions.
         /// This change is made whenever an avatar enters a region, whether by crossing over from a neighbouring sim,
@@ -987,49 +998,52 @@ namespace OpenSim.Region.Framework.Scenes
         ///
         /// This method is on the critical path for transferring an avatar from one region to another.  Delay here
         /// delays that crossing.
-        /// </summary>
-        private void MakeRootAgent(Vector3 pos, bool isFlying)
+        /// </remarks>
+        private bool MakeRootAgent(Vector3 pos, bool isFlying)
         {
-//            m_log.InfoFormat(
-//                "[SCENE]: Upgrading child to root agent for {0} in {1}",
-//                Name, m_scene.RegionInfo.RegionName);
-
-            if (ParentUUID != UUID.Zero)
+            lock (m_completeMovementLock)
             {
-                m_log.DebugFormat("[SCENE PRESENCE]: Sitting avatar back on prim {0}", ParentUUID);
-                SceneObjectPart part = m_scene.GetSceneObjectPart(ParentUUID);
-                if (part == null)
+                if (!IsChildAgent)
+                    return false;
+
+                //m_log.DebugFormat("[SCENE]: known regions in {0}: {1}", Scene.RegionInfo.RegionName, KnownChildRegionHandles.Count);
+
+    //            m_log.InfoFormat(
+    //                "[SCENE]: Upgrading child to root agent for {0} in {1}",
+    //                Name, m_scene.RegionInfo.RegionName);
+
+                if (ParentUUID != UUID.Zero)
                 {
-                    m_log.ErrorFormat("[SCENE PRESENCE]: Can't find prim {0} to sit on", ParentUUID);
+                    m_log.DebugFormat("[SCENE PRESENCE]: Sitting avatar back on prim {0}", ParentUUID);
+                    SceneObjectPart part = m_scene.GetSceneObjectPart(ParentUUID);
+                    if (part == null)
+                    {
+                        m_log.ErrorFormat("[SCENE PRESENCE]: Can't find prim {0} to sit on", ParentUUID);
+                    }
+                    else
+                    {
+                        part.ParentGroup.AddAvatar(UUID);
+                        if (part.SitTargetPosition != Vector3.Zero)
+                            part.SitTargetAvatar = UUID;
+    //                    ParentPosition = part.GetWorldPosition();
+                        ParentID = part.LocalId;
+                        ParentPart = part;
+                        m_pos = PrevSitOffset;
+    //                    pos = ParentPosition;
+                        pos = part.GetWorldPosition();
+                    }
+                    ParentUUID = UUID.Zero;
+
+    //                Animator.TrySetMovementAnimation("SIT");
                 }
                 else
                 {
-                    part.ParentGroup.AddAvatar(UUID);
-                    if (part.SitTargetPosition != Vector3.Zero)
-                        part.SitTargetAvatar = UUID;
-//                    ParentPosition = part.GetWorldPosition();
-                    ParentID = part.LocalId;
-                    ParentPart = part;
-                    m_pos = PrevSitOffset;
-//                    pos = ParentPosition;
-                    pos = part.GetWorldPosition();
+                    IsLoggingIn = false;
                 }
-                ParentUUID = UUID.Zero;
-
-                IsChildAgent = false;
 
-//                Animator.TrySetMovementAnimation("SIT");
-            }
-            else
-            {
                 IsChildAgent = false;
-                IsLoggingIn = false;
             }
 
-            //m_log.DebugFormat("[SCENE]: known regions in {0}: {1}", Scene.RegionInfo.RegionName, KnownChildRegionHandles.Count);
-
-            IsChildAgent = false;
-
             // Must reset this here so that a teleport to a region next to an existing region does not keep the flag
             // set and prevent the close of the connection on a subsequent re-teleport.
             // Should not be needed if we are not trying to tell this region to close
@@ -1216,6 +1230,7 @@ namespace OpenSim.Region.Framework.Scenes
 
             m_scene.EventManager.TriggerOnMakeRootAgent(this);
 
+            return true;
         }
 
         public int GetStateSource()
@@ -1639,7 +1654,14 @@ namespace OpenSim.Region.Framework.Scenes
             }
 
             bool flying = ((m_AgentControlFlags & AgentManager.ControlFlags.AGENT_CONTROL_FLY) != 0);
-            MakeRootAgent(AbsolutePosition, flying);
+            if (!MakeRootAgent(AbsolutePosition, flying))
+            {
+                m_log.DebugFormat(
+                    "[SCENE PRESENCE]: Aborting CompleteMovement call for {0} in {1} as they are already root", 
+                    Name, Scene.Name);
+
+                return;
+            }
 
             // Tell the client that we're totally ready
             ControllingClient.MoveAgentIntoRegion(m_scene.RegionInfo, AbsolutePosition, look);
diff --git a/OpenSim/Region/Framework/Scenes/Tests/ScenePresenceAgentTests.cs b/OpenSim/Region/Framework/Scenes/Tests/ScenePresenceAgentTests.cs
index d1aeaee..1ff1329 100644
--- a/OpenSim/Region/Framework/Scenes/Tests/ScenePresenceAgentTests.cs
+++ b/OpenSim/Region/Framework/Scenes/Tests/ScenePresenceAgentTests.cs
@@ -111,6 +111,45 @@ namespace OpenSim.Region.Framework.Scenes.Tests
             Assert.That(scene.GetScenePresences().Count, Is.EqualTo(1));
         }
 
+        /// <summary>
+        /// Test that duplicate complete movement calls are ignored.
+        /// </summary>
+        /// <remarks>
+        /// If duplicate calls are not ignored then there is a risk of race conditions or other unexpected effects.
+        /// </remarks>
+        [Test]
+        public void TestDupeCompleteMovementCalls()
+        {
+            TestHelpers.InMethod();
+//            TestHelpers.EnableLogging();
+
+            UUID spUuid = TestHelpers.ParseTail(0x1);
+
+            TestScene scene = new SceneHelpers().SetupScene();
+
+            int makeRootAgentEvents = 0;
+            scene.EventManager.OnMakeRootAgent += spi => makeRootAgentEvents++;
+
+            ScenePresence sp = SceneHelpers.AddScenePresence(scene, spUuid);
+
+            Assert.That(makeRootAgentEvents, Is.EqualTo(1));
+
+            // Normally these would be invoked by a CompleteMovement message coming in to the UDP stack.  But for
+            // convenience, here we will invoke it manually.
+            sp.CompleteMovement(sp.ControllingClient, true);
+
+            Assert.That(makeRootAgentEvents, Is.EqualTo(1));
+
+            // Check rest of exepcted parameters.
+            Assert.That(scene.AuthenticateHandler.GetAgentCircuitData(spUuid), Is.Not.Null);
+            Assert.That(scene.AuthenticateHandler.GetAgentCircuits().Count, Is.EqualTo(1));
+          
+            Assert.That(sp.IsChildAgent, Is.False);
+            Assert.That(sp.UUID, Is.EqualTo(spUuid));
+
+            Assert.That(scene.GetScenePresences().Count, Is.EqualTo(1));
+        }
+
         [Test]
         public void TestCreateDuplicateRootScenePresence()
         {
@@ -249,58 +288,5 @@ namespace OpenSim.Region.Framework.Scenes.Tests
 //            Assert.That(childPresence, Is.Not.Null);
 //            Assert.That(childPresence.IsChildAgent, Is.True);
         }
-
-//        /// <summary>
-//        /// Test adding a root agent to a scene.  Doesn't yet actually complete crossing the agent into the scene.
-//        /// </summary>
-//        [Test]
-//        public void T010_TestAddRootAgent()
-//        {
-//            TestHelpers.InMethod();
-//
-//            string firstName = "testfirstname";
-//
-//            AgentCircuitData agent = new AgentCircuitData();
-//            agent.AgentID = agent1;
-//            agent.firstname = firstName;
-//            agent.lastname = "testlastname";
-//            agent.SessionID = UUID.Random();
-//            agent.SecureSessionID = UUID.Random();
-//            agent.circuitcode = 123;
-//            agent.BaseFolder = UUID.Zero;
-//            agent.InventoryFolder = UUID.Zero;
-//            agent.startpos = Vector3.Zero;
-//            agent.CapsPath = GetRandomCapsObjectPath();
-//            agent.ChildrenCapSeeds = new Dictionary<ulong, string>();
-//            agent.child = true;
-//
-//            scene.PresenceService.LoginAgent(agent.AgentID.ToString(), agent.SessionID, agent.SecureSessionID);
-//
-//            string reason;
-//            scene.NewUserConnection(agent, (uint)TeleportFlags.ViaLogin, out reason);
-//            testclient = new TestClient(agent, scene);
-//            scene.AddNewAgent(testclient);
-//
-//            ScenePresence presence = scene.GetScenePresence(agent1);
-//
-//            Assert.That(presence, Is.Not.Null, "presence is null");
-//            Assert.That(presence.Firstname, Is.EqualTo(firstName), "First name not same");
-//            acd1 = agent;
-//        }
-//
-//        /// <summary>
-//        /// Test removing an uncrossed root agent from a scene.
-//        /// </summary>
-//        [Test]
-//        public void T011_TestRemoveRootAgent()
-//        {
-//            TestHelpers.InMethod();
-//
-//            scene.RemoveClient(agent1);
-//
-//            ScenePresence presence = scene.GetScenePresence(agent1);
-//
-//            Assert.That(presence, Is.Null, "presence is not null");
-//        }
     }
 }
\ No newline at end of file