7 files changed, 115 insertions, 45 deletions

diff --git a/OpenSim/Region/Framework/Interfaces/IRegionReadyModule.cs b/OpenSim/Region/Framework/Interfaces/IRegionReadyModule.cs
index aa4a757..136ca92 100644
--- a/OpenSim/Region/Framework/Interfaces/IRegionReadyModule.cs
+++ b/OpenSim/Region/Framework/Interfaces/IRegionReadyModule.cs
@@ -25,14 +25,23 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-
 using System;
+using OpenSim.Framework;
 
 namespace OpenSim.Region.Framework.Interfaces
 {
     public interface IRegionReadyModule
     {
         void OarLoadingAlert(string msg);
+
+        /// <summary>
+        /// Trigger region ready status manually.
+        /// </summary>
+        /// <remarks>
+        /// This should be called by the scene if the IRegionReadyModule has set Scene.LoginLock == true
+        /// </remarks>
+        /// <param name='scene'></param>
+        void TriggerRegionReady(IScene scene);
     }
 }
 
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index d783e57..418904f 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -500,15 +500,25 @@ namespace OpenSim.Region.Framework.Scenes
         public delegate void RegionHeartbeatEnd(Scene scene);
         public event RegionHeartbeatEnd OnRegionHeartbeatEnd;
 
-        public delegate void LoginsEnabled(string regionName);
+        /// <summary>
+        /// Fired when logins to a region are enabled or disabled.
+        /// </summary>
+        /// <remarks>
+        /// 
+        /// </remarks>
+        /// Fired
+        public event RegionLoginsStatusChange OnRegionLoginsStatusChange;
+        public delegate void RegionLoginsStatusChange(IScene scene);
 
         /// <summary>
-        /// This should only fire in all circumstances if the RegionReady module is active.
+        /// Fired when a region is considered ready for use.
         /// </summary>
         /// <remarks>
-        /// TODO: Fire this even when the RegionReady module is not active.
+        /// A region is considered ready when startup operations such as loading of scripts already on the region
+        /// have been completed.
         /// </remarks>
-        public event LoginsEnabled OnLoginsEnabled;
+        public event RegionReady OnRegionReady;
+        public delegate void RegionReady(IScene scene);
 
         public delegate void PrimsLoaded(Scene s);
         public event PrimsLoaded OnPrimsLoaded;
@@ -2502,21 +2512,42 @@ namespace OpenSim.Region.Framework.Scenes
             }
         }
 
-        public void TriggerLoginsEnabled (string regionName)
+        public void TriggerRegionLoginsStatusChange(IScene scene)
         {
-            LoginsEnabled handler = OnLoginsEnabled;
+            RegionLoginsStatusChange handler = OnRegionLoginsStatusChange;
 
-            if ( handler != null)
+            if (handler != null)
             {
-                foreach (LoginsEnabled d in handler.GetInvocationList())
+                foreach (RegionLoginsStatusChange d in handler.GetInvocationList())
                 {
                     try
                     {
-                        d(regionName);
+                        d(scene);
+                    }
+                    catch (Exception e)
+                    {
+                        m_log.ErrorFormat("[EVENT MANAGER]: Delegate for OnRegionLoginsStatusChange failed - continuing {0} - {1}",
+                            e.Message, e.StackTrace);
+                    }
+                }
+            }
+        }
+
+        public void TriggerRegionReady(IScene scene)
+        {
+            RegionReady handler = OnRegionReady;
+
+            if (handler != null)
+            {
+                foreach (RegionReady d in handler.GetInvocationList())
+                {
+                    try
+                    {
+                        d(scene);
                     }
                     catch (Exception e)
                     {
-                        m_log.ErrorFormat("[EVENT MANAGER]: Delegate for LoginsEnabled failed - continuing {0} - {1}",
+                        m_log.ErrorFormat("[EVENT MANAGER]: Delegate for OnRegionReady failed - continuing {0} - {1}",
                             e.Message, e.StackTrace);
                     }
                 }
diff --git a/OpenSim/Region/Framework/Scenes/Scene.cs b/OpenSim/Region/Framework/Scenes/Scene.cs
index f501828..645b3d5 100644
--- a/OpenSim/Region/Framework/Scenes/Scene.cs
+++ b/OpenSim/Region/Framework/Scenes/Scene.cs
@@ -129,9 +129,10 @@ namespace OpenSim.Region.Framework.Scenes
         public bool m_strictAccessControl = true;
         public bool m_seeIntoBannedRegion = false;
         public int MaxUndoCount = 5;
+
         // Using this for RegionReady module to prevent LoginsDisabled from changing under our feet;
         public bool LoginLock = false;
-        public bool LoginsDisabled = true;
+
         public bool StartDisabled = false;
         public bool LoadingPrims;
         public IXfer XferManager;
@@ -727,6 +728,8 @@ namespace OpenSim.Region.Framework.Scenes
                 {
                     IConfig startupConfig = m_config.Configs["Startup"];
 
+                    StartDisabled = startupConfig.GetBoolean("StartDisabled", false);
+
                     m_defaultDrawDistance = startupConfig.GetFloat("DefaultDrawDistance",m_defaultDrawDistance);
                     m_useBackup = startupConfig.GetBoolean("UseSceneBackup", m_useBackup);
                     if (!m_useBackup)
@@ -1530,7 +1533,7 @@ namespace OpenSim.Region.Framework.Scenes
                     //    landMS = Util.EnvironmentTickCountSubtract(ldMS);
                     //}
     
-                    if (LoginsDisabled && Frame == 20)
+                    if (!LoginsEnabled && Frame == 20)
                     {
     //                    m_log.DebugFormat("{0} {1} {2}", LoginsDisabled, m_sceneGraph.GetActiveScriptsCount(), LoginLock);
     
@@ -1538,31 +1541,34 @@ namespace OpenSim.Region.Framework.Scenes
                         // this is a rare case where we know we have just went through a long cycle of heap
                         // allocations, and there is no more work to be done until someone logs in
                         GC.Collect();
-    
-                        IConfig startupConfig = m_config.Configs["Startup"];
-                        if (startupConfig == null || !startupConfig.GetBoolean("StartDisabled", false))
+
+                        if (!LoginLock)
                         {
-                            // This handles a case of a region having no scripts for the RegionReady module
-                            if (m_sceneGraph.GetActiveScriptsCount() == 0)
-                            {
-                                // need to be able to tell these have changed in RegionReady
-                                LoginLock = false;
-                                EventManager.TriggerLoginsEnabled(RegionInfo.RegionName);
-                            }
-    
-                            // For RegionReady lockouts
-                            if (!LoginLock)
+                            if (!StartDisabled)
                             {
                                 m_log.InfoFormat("[REGION]: Enabling logins for {0}", RegionInfo.RegionName);
-                                LoginsDisabled = false;
+                                LoginsEnabled = true;
                             }
-    
-                            m_sceneGridService.InformNeighborsThatRegionisUp(RequestModuleInterface<INeighbourService>(), RegionInfo);
+
+                            m_sceneGridService.InformNeighborsThatRegionisUp(
+                                RequestModuleInterface<INeighbourService>(), RegionInfo);
+
+                            // Region ready should always be triggered whether logins are immediately enabled or not.
+                            EventManager.TriggerRegionReady(this);
                         }
                         else
                         {
-                            StartDisabled = true;
-                            LoginsDisabled = true;
+                            // This handles a case of a region having no scripts for the RegionReady module
+                            if (m_sceneGraph.GetActiveScriptsCount() == 0)
+                            {
+                                // In this case, we leave it to the IRegionReadyModule to enable logins
+                               
+                                // LoginLock can currently only be set by a region module implementation.
+                                // If somehow this hasn't been done then the quickest way to bugfix is to see the
+                                // NullReferenceException
+                                IRegionReadyModule rrm = RequestModuleInterface<IRegionReadyModule>();
+                                rrm.TriggerRegionReady(this);
+                            }
                         }
                     }
                 }
@@ -3487,25 +3493,31 @@ namespace OpenSim.Region.Framework.Scenes
                 if (AgentTransactionsModule != null)
                     AgentTransactionsModule.RemoveAgentAssetTransactions(agentID);
 
-                avatar.Close();
-
                 m_authenticateHandler.RemoveCircuit(avatar.ControllingClient.CircuitCode);
                 m_log.Debug("[Scene] The avatar has left the building");
             }
             catch (Exception e)
             {
                 m_log.Error(
-                    string.Format("[SCENE]: Exception removing {0} from {1}, ", avatar.Name, RegionInfo.RegionName), e);
+                    string.Format("[SCENE]: Exception removing {0} from {1}.  Cleaning up.  Exception ", avatar.Name, Name), e);
             }
             finally
             {
-                // Always clean these structures up so that any failure above doesn't cause them to remain in the
-                // scene with possibly bad effects (e.g. continually timing out on unacked packets and triggering
-                // the same cleanup exception continually.
-                // TODO: This should probably extend to the whole method, but we don't want to also catch the NRE
-                // since this would hide the underlying failure and other associated problems.
-                m_sceneGraph.RemoveScenePresence(agentID);
-                m_clientManager.Remove(agentID);
+                try
+                {
+                    // Always clean these structures up so that any failure above doesn't cause them to remain in the
+                    // scene with possibly bad effects (e.g. continually timing out on unacked packets and triggering
+                    // the same cleanup exception continually.
+                    m_sceneGraph.RemoveScenePresence(agentID);
+                    m_clientManager.Remove(agentID);
+    
+                    avatar.Close();
+                }
+                catch (Exception e)
+                {
+                    m_log.Error(
+                        string.Format("[SCENE]: Exception in final clean up of {0} in {1}.  Exception ", avatar.Name, Name), e);
+                }
             }
 
             //m_log.InfoFormat("[SCENE] Memory pre  GC {0}", System.GC.GetTotalMemory(false));
@@ -3619,7 +3631,7 @@ namespace OpenSim.Region.Framework.Scenes
                 agent.startpos
             );
 
-            if (LoginsDisabled)
+            if (!LoginsEnabled)
             {
                 reason = "Logins Disabled";
                 return false;
diff --git a/OpenSim/Region/Framework/Scenes/SceneBase.cs b/OpenSim/Region/Framework/Scenes/SceneBase.cs
index 8db4397..d55b082 100644
--- a/OpenSim/Region/Framework/Scenes/SceneBase.cs
+++ b/OpenSim/Region/Framework/Scenes/SceneBase.cs
@@ -106,6 +106,24 @@ namespace OpenSim.Region.Framework.Scenes
         
         protected readonly ClientManager m_clientManager = new ClientManager();
 
+        public bool LoginsEnabled
+        {
+            get
+            {
+                return m_loginsEnabled;
+            }
+
+            set
+            {
+                if (m_loginsEnabled != value)
+                {
+                    m_loginsEnabled = value;
+                    EventManager.TriggerRegionLoginsStatusChange(this);
+                }
+            }
+        }
+        private bool m_loginsEnabled;
+
         public float TimeDilation
         {
             get { return 1.0f; }
diff --git a/OpenSim/Region/Framework/Scenes/SceneCommunicationService.cs b/OpenSim/Region/Framework/Scenes/SceneCommunicationService.cs
index 5d8447b..775a4c2 100644
--- a/OpenSim/Region/Framework/Scenes/SceneCommunicationService.cs
+++ b/OpenSim/Region/Framework/Scenes/SceneCommunicationService.cs
@@ -100,7 +100,7 @@ namespace OpenSim.Region.Framework.Scenes
             {
                 m_log.WarnFormat(
                     "[SCENE COMMUNICATION SERVICE]: Region {0} failed to inform neighbour at {1}-{2} that it is up.",
-                    x / Constants.RegionSize, y / Constants.RegionSize);
+                    m_scene.Name, x / Constants.RegionSize, y / Constants.RegionSize);
             }
         }
 
diff --git a/OpenSim/Region/Framework/Scenes/SceneObjectGroup.cs b/OpenSim/Region/Framework/Scenes/SceneObjectGroup.cs
index 6ab0027..08c7a58 100644
--- a/OpenSim/Region/Framework/Scenes/SceneObjectGroup.cs
+++ b/OpenSim/Region/Framework/Scenes/SceneObjectGroup.cs
@@ -1991,7 +1991,7 @@ namespace OpenSim.Region.Framework.Scenes
             try
             {
                 if (!m_scene.ShuttingDown || // if shutting down then there will be nothing to handle the return so leave till next restart
-                        m_scene.LoginsDisabled || // We're starting up or doing maintenance, don't mess with things
+                        !m_scene.LoginsEnabled || // We're starting up or doing maintenance, don't mess with things
                         m_scene.LoadingPrims) // Land may not be valid yet
                 
                 {
diff --git a/OpenSim/Region/Framework/Scenes/Tests/ScenePresenceTeleportTests.cs b/OpenSim/Region/Framework/Scenes/Tests/ScenePresenceTeleportTests.cs
index a407f01..37b5184 100644
--- a/OpenSim/Region/Framework/Scenes/Tests/ScenePresenceTeleportTests.cs
+++ b/OpenSim/Region/Framework/Scenes/Tests/ScenePresenceTeleportTests.cs
@@ -301,7 +301,7 @@ namespace OpenSim.Region.Framework.Scenes.Tests
             sp.AbsolutePosition = preTeleportPosition;
 
             // Make sceneB refuse CreateAgent
-            sceneB.LoginsDisabled = true;
+            sceneB.LoginsEnabled = false;
 
             sceneA.RequestTeleportLocation(
                 sp.ControllingClient,