Bandaid for ghost users, check and remove them from Presence when they log on.

Once again OOP proves it's worse that spaghetti, but cutting up the
spaghetti and hiding it all over the kitchen.

Note the commented out bits from GateKeeperService.cs, this stuff is
checked TWICE, though this time is for HGers, or not.

12 files changed, 197 insertions, 5 deletions

diff --git a/OpenSim/Data/IPresenceData.cs b/OpenSim/Data/IPresenceData.cs
index 4086245..b026995 100644
--- a/OpenSim/Data/IPresenceData.cs
+++ b/OpenSim/Data/IPresenceData.cs
@@ -49,6 +49,7 @@ namespace OpenSim.Data
         bool Store(PresenceData data);
 
         PresenceData Get(UUID sessionID);
+        PresenceData GetByUser(UUID userID);
         void LogoutRegionAgents(UUID regionID);
         bool ReportAgent(UUID sessionID, UUID regionID);
         PresenceData[] Get(string field, string data);
diff --git a/OpenSim/Data/MySQL/MySQLPresenceData.cs b/OpenSim/Data/MySQL/MySQLPresenceData.cs
index 70aca5f..b9114eb 100644
--- a/OpenSim/Data/MySQL/MySQLPresenceData.cs
+++ b/OpenSim/Data/MySQL/MySQLPresenceData.cs
@@ -52,8 +52,17 @@ namespace OpenSim.Data.MySQL
 
         public PresenceData Get(UUID sessionID)
         {
-            PresenceData[] ret = Get("SessionID",
-                    sessionID.ToString());
+            PresenceData[] ret = Get("SessionID", sessionID.ToString());
+
+            if (ret.Length == 0)
+                return null;
+
+            return ret[0];
+        }
+
+        public PresenceData GetByUser(UUID userID)
+        {
+            PresenceData[] ret = Get("UserID", userID.ToString());
 
             if (ret.Length == 0)
                 return null;
diff --git a/OpenSim/Data/Null/NullPresenceData.cs b/OpenSim/Data/Null/NullPresenceData.cs
index 8c442c9..ce1404e 100644
--- a/OpenSim/Data/Null/NullPresenceData.cs
+++ b/OpenSim/Data/Null/NullPresenceData.cs
@@ -79,6 +79,19 @@ namespace OpenSim.Data.Null
             return null;
         }
 
+        public PresenceData GetByUser(UUID userID)
+        {
+            if (Instance != this)
+                return Instance.GetByUser(userID);
+
+            if (m_presenceData.ContainsKey(userID))
+            {
+                return m_presenceData[userID];
+            }
+
+            return null;
+        }
+
         public void LogoutRegionAgents(UUID regionID)
         {
             if (Instance != this)
diff --git a/OpenSim/Data/PGSQL/PGSQLPresenceData.cs b/OpenSim/Data/PGSQL/PGSQLPresenceData.cs
index ebbe8d3..51154af 100644
--- a/OpenSim/Data/PGSQL/PGSQLPresenceData.cs
+++ b/OpenSim/Data/PGSQL/PGSQLPresenceData.cs
@@ -60,6 +60,16 @@ namespace OpenSim.Data.PGSQL
             return ret[0];
         }
 
+        public PresenceData GetByUser(UUID userID)
+        {
+            PresenceData[] ret = Get("UserID", userID.ToString());
+
+            if (ret.Length == 0)
+                return null;
+
+            return ret[0];
+        }
+
         public void LogoutRegionAgents(UUID regionID)
         {
             using (NpgsqlConnection conn = new NpgsqlConnection(m_ConnectionString))
diff --git a/OpenSim/Region/CoreModules/ServiceConnectorsOut/Presence/BasePresenceServiceConnector.cs b/OpenSim/Region/CoreModules/ServiceConnectorsOut/Presence/BasePresenceServiceConnector.cs
index fdbe10a..e014a57 100644
--- a/OpenSim/Region/CoreModules/ServiceConnectorsOut/Presence/BasePresenceServiceConnector.cs
+++ b/OpenSim/Region/CoreModules/ServiceConnectorsOut/Presence/BasePresenceServiceConnector.cs
@@ -123,6 +123,11 @@ namespace OpenSim.Region.CoreModules.ServiceConnectorsOut.Presence
             return m_PresenceService.GetAgent(sessionID);
         }
 
+        public PresenceInfo GetAgentByUser(UUID userID)
+        {
+            return m_PresenceService.GetAgentByUser(userID);
+        }
+
         public PresenceInfo[] GetAgents(string[] userIDs)
         {
             // Don't bother potentially making a useless network call if we not going to ask for any users anyway.
diff --git a/OpenSim/Region/Framework/Interfaces/IPresenceModule.cs b/OpenSim/Region/Framework/Interfaces/IPresenceModule.cs
index fb5933c..398611c 100644
--- a/OpenSim/Region/Framework/Interfaces/IPresenceModule.cs
+++ b/OpenSim/Region/Framework/Interfaces/IPresenceModule.cs
@@ -33,11 +33,19 @@ namespace OpenSim.Region.Framework.Interfaces
     {
         public string UserID;
         public UUID RegionID;
+        public UUID SessionID;
 
+        public PresenceInfo(string userID, UUID regionID, UUID sessionID)
+        {
+            UserID = userID;
+            RegionID = regionID;
+            SessionID = sessionID;
+        }
         public PresenceInfo(string userID, UUID regionID)
         {
             UserID = userID;
             RegionID = regionID;
+            SessionID = UUID.Zero;
         }
     }
 
diff --git a/OpenSim/Services/Connectors/Presence/PresenceServicesConnector.cs b/OpenSim/Services/Connectors/Presence/PresenceServicesConnector.cs
index 89d64ca..04a0c5e 100644
--- a/OpenSim/Services/Connectors/Presence/PresenceServicesConnector.cs
+++ b/OpenSim/Services/Connectors/Presence/PresenceServicesConnector.cs
@@ -329,6 +329,63 @@ namespace OpenSim.Services.Connectors
             return pinfo;
         }
 
+        public PresenceInfo GetAgentByUser(UUID userID)
+        {
+            Dictionary<string, object> sendData = new Dictionary<string, object>();
+            //sendData["SCOPEID"] = scopeID.ToString();
+            sendData["VERSIONMIN"] = ProtocolVersions.ClientProtocolVersionMin.ToString();
+            sendData["VERSIONMAX"] = ProtocolVersions.ClientProtocolVersionMax.ToString();
+            sendData["METHOD"] = "getagentbyuser";
+
+            sendData["UserID"] = userID.ToString();
+
+            string reply = string.Empty;
+            string reqString = ServerUtils.BuildQueryString(sendData);
+            string uri = m_ServerURI + "/presence";
+            // m_log.DebugFormat("[PRESENCE CONNECTOR]: queryString = {0}", reqString);
+            try
+            {
+                reply = SynchronousRestFormsRequester.MakeRequest("POST",
+                        uri,
+                        reqString,
+                        m_Auth);
+                if (reply == null || (reply != null && reply == string.Empty))
+                {
+                    m_log.DebugFormat("[PRESENCE CONNECTOR]: GetAgentByUser received null or empty reply");
+                    return null;
+                }
+            }
+            catch (Exception e)
+            {
+                m_log.DebugFormat("[PRESENCE CONNECTOR]: Exception when contacting presence server at {0}: {1}", uri, e.Message);
+                return null;
+            }
+
+            Dictionary<string, object> replyData = ServerUtils.ParseXmlResponse(reply);
+            PresenceInfo pinfo = null;
+
+            if ((replyData != null) && replyData.ContainsKey("result") && (replyData["result"] != null))
+            {
+                if (replyData["result"] is Dictionary<string, object>)
+                {
+                    pinfo = new PresenceInfo((Dictionary<string, object>)replyData["result"]);
+                }
+                else
+                {
+                    if (replyData["result"].ToString() == "null")
+                        return null;
+
+                    m_log.DebugFormat("[PRESENCE CONNECTOR]: Invalid reply (result not dictionary) received from presence server when querying for userID {0}", userID.ToString());
+                }
+            }
+            else
+            {
+                m_log.DebugFormat("[PRESENCE CONNECTOR]: Invalid reply received from presence server when querying for userID {0}", userID.ToString());
+            }
+
+            return pinfo;
+        }
+
         public PresenceInfo[] GetAgents(string[] userIDs)
         {
             Dictionary<string, object> sendData = new Dictionary<string, object>();
diff --git a/OpenSim/Services/Connectors/SimianGrid/SimianPresenceServiceConnector.cs b/OpenSim/Services/Connectors/SimianGrid/SimianPresenceServiceConnector.cs
index 08efefb..2a34379 100644
--- a/OpenSim/Services/Connectors/SimianGrid/SimianPresenceServiceConnector.cs
+++ b/OpenSim/Services/Connectors/SimianGrid/SimianPresenceServiceConnector.cs
@@ -222,6 +222,18 @@ namespace OpenSim.Services.Connectors.SimianGrid
             return ResponseToPresenceInfo(sessionResponse);
         }
 
+        public PresenceInfo GetAgentByUser(UUID userID)
+        {
+            OSDMap userResponse = GetUserData(userID);
+            if (userResponse == null)
+            {
+                m_log.WarnFormat("[SIMIAN PRESENCE CONNECTOR]: Failed to retrieve user data for {0}: {1}",userID.ToString(),userResponse["Message"].AsString());
+                return null;
+            }
+
+            return ResponseToPresenceInfo(userResponse);
+        }
+
         public PresenceInfo[] GetAgents(string[] userIDs)
         {
             List<PresenceInfo> presences = new List<PresenceInfo>();
diff --git a/OpenSim/Services/HypergridService/GatekeeperService.cs b/OpenSim/Services/HypergridService/GatekeeperService.cs
index 5c6abd2..24979be 100644
--- a/OpenSim/Services/HypergridService/GatekeeperService.cs
+++ b/OpenSim/Services/HypergridService/GatekeeperService.cs
@@ -391,13 +391,39 @@ namespace OpenSim.Services.HypergridService
 
                 if(!m_allowDuplicatePresences)
                 {
+//// TODO - Should also check Presence.UserID if RegionID == UUID.Zero, they are a ghost.  Maybe.
+////            NOTE - this is a person hypergridding in, or returning home, or just logging in and it's duplicating effort in OpenSim/Services/LLLoginService/LLLoginService.cs.
                     if(guinfo != null && guinfo.Online && guinfo.LastRegionID != UUID.Zero)
                     {
-                        if(SendAgentGodKillToRegion(UUID.Zero, agentID, guinfo))
+                        // Also check Presence.UserID if RegionID == UUID.Zero, they are a ghost.
+                        // Ghosting might be caused by failure to call PresenceService.LogoutAgent() on logout / crash / failed login.
+                        // Might also need to double check if they are out hypergridding.
+
+                        bool success = false;
+                        if (m_PresenceService != null)
+                        {
+                            PresenceInfo pi = m_PresenceService.GetAgentByUser(account.PrincipalID);
+                            if (null != pi)
+                            {
+                                Dictionary<string, object> pid = pi.ToKeyValuePairs();
+                                if ((pid["RegionID"].ToString() == UUID.Zero.ToString()) && (0 != String.Compare(pid["SessionID"].ToString(), aCircuit.SessionID.ToString())))
+                                {
+                                    m_log.WarnFormat("[GATEKEEPER SERVICE]: Exorcising ghost avatar {0}, session {1}, new session {2}.", pid["UserID"], pid["SessionID"], aCircuit.SessionID);
+m_log.WarnFormat("[GATEKEEPER SERVICE]: NOT REALLY.");
+//// Don't do this until after more checking.
+////                                        success = m_PresenceService.LogoutAgent(new UUID(pid["SessionID"].ToString()));
+////                                        if (success)
+////                                    m_log.WarnFormat("[GATEKEEPER SERVICE]: Ghost avatar exorcised {0}, session {1}, new session {2}.", pid["UserID"], pid["SessionID"], aCircuit.SessionID);
+////                                else
+////                                    m_log.ErrorFormat("[GATEKEEPER SERVICE]: Ghost avatar not exorcised {0}, session {1}, new session {2}!", pid["UserID"], pid["SessionID"], aCircuit.SessionID);
+                                }
+                            }
+                        }
+                        if ((!success) && SendAgentGodKillToRegion(UUID.Zero, agentID, guinfo))
                         {
                             if(account != null)
                                 m_log.InfoFormat(
-                                    "[GATEKEEPER SERVICE]: Login failed for {0} {1}, reason: already logged in",
+                                    "[GATEKEEPER SERVICE]: Login failed for {0} {1}, reason: already logged in.  This may be bogus if a ghost avatar was exorcised above.",
                                     account.FirstName, account.LastName);
                             reason = "You appear to be already logged in on the destination grid " +
                                     "Please wait a a minute or two and retry. " +
diff --git a/OpenSim/Services/Interfaces/IPresenceService.cs b/OpenSim/Services/Interfaces/IPresenceService.cs
index 90f9842..4843759 100644
--- a/OpenSim/Services/Interfaces/IPresenceService.cs
+++ b/OpenSim/Services/Interfaces/IPresenceService.cs
@@ -36,6 +36,7 @@ namespace OpenSim.Services.Interfaces
     {
         public string UserID;
         public UUID RegionID;
+        public UUID SessionID;
 
         public PresenceInfo()
         {
@@ -47,6 +48,8 @@ namespace OpenSim.Services.Interfaces
                 UserID = kvp["UserID"].ToString();
             if (kvp.ContainsKey("RegionID"))
                 UUID.TryParse(kvp["RegionID"].ToString(), out RegionID);
+            if (kvp.ContainsKey("SessionID"))
+                UUID.TryParse(kvp["SessionID"].ToString(), out SessionID);
         }
 
         public Dictionary<string, object> ToKeyValuePairs()
@@ -54,6 +57,7 @@ namespace OpenSim.Services.Interfaces
             Dictionary<string, object> result = new Dictionary<string, object>();
             result["UserID"] = UserID;
             result["RegionID"] = RegionID.ToString();
+            result["SessionID"] = SessionID.ToString();
 
             return result;
         }
@@ -100,6 +104,13 @@ namespace OpenSim.Services.Interfaces
         PresenceInfo GetAgent(UUID sessionID);
 
         /// <summary>
+        /// Get session information for a given session ID.
+        /// </summary>
+        /// <returns></returns>
+        /// <param name='sessionID'></param>
+        PresenceInfo GetAgentByUser(UUID userID);
+
+        /// <summary>
         /// Get session information for a collection of users.
         /// </summary>
         /// <returns>Session information for the users.</returns>
diff --git a/OpenSim/Services/LLLoginService/LLLoginService.cs b/OpenSim/Services/LLLoginService/LLLoginService.cs
index 53a3c2f..cad0988 100644
--- a/OpenSim/Services/LLLoginService/LLLoginService.cs
+++ b/OpenSim/Services/LLLoginService/LLLoginService.cs
@@ -390,7 +390,30 @@ namespace OpenSim.Services.LLLoginService
                 {
                     if(guinfo != null && guinfo.Online && guinfo.LastRegionID != UUID.Zero)
                     {
-                        if(SendAgentGodKillToRegion(scopeID, account.PrincipalID, guinfo))
+                        // Also check Presence.UserID if RegionID == UUID.Zero, they are a ghost.
+                        // Ghosting might be caused by failure to call PresenceService.LogoutAgent() on logout / crash / failed login.
+                        // Might also need to double check if they are out hypergridding.
+
+                        success = false;
+                        if (m_PresenceService != null)
+                        {
+                            PresenceInfo pi = m_PresenceService.GetAgentByUser(account.PrincipalID);
+                            if (null != pi)
+                            {
+                                Dictionary<string, object> pid = pi.ToKeyValuePairs();
+                                if (pid["RegionID"].ToString() == UUID.Zero.ToString())
+                                {
+                                    m_log.WarnFormat("[LLOGIN SERVICE]: Exorcising ghost avatar {0} {1}, session {2}, new session {3}.", firstName, lastName, pid["SessionID"], session);
+                                    success = m_PresenceService.LogoutAgent(new UUID(pid["SessionID"].ToString()));
+                                    if (success)
+                                        m_log.WarnFormat("[LLOGIN SERVICE]: Ghost avatar exorcised {0} {1}, session {2}, new session {3}.", firstName, lastName, pid["SessionID"], session);
+                                    else
+                                        m_log.ErrorFormat("[LLOGIN SERVICE]: Ghost avatar not exorcised {0} {1}, session {2}, new session {3}!", firstName, lastName, pid["SessionID"], session);
+                                }
+                            }
+                        }
+
+                        if ((!success) && SendAgentGodKillToRegion(scopeID, account.PrincipalID, guinfo))
                         {
                             m_log.InfoFormat(
                                 "[LLOGIN SERVICE]: Login failed for {0} {1}, reason: already logged in",
diff --git a/OpenSim/Services/PresenceService/PresenceService.cs b/OpenSim/Services/PresenceService/PresenceService.cs
index 0392409..1059b2b 100644
--- a/OpenSim/Services/PresenceService/PresenceService.cs
+++ b/OpenSim/Services/PresenceService/PresenceService.cs
@@ -151,6 +151,22 @@ namespace OpenSim.Services.PresenceService
 
             ret.UserID = data.UserID;
             ret.RegionID = data.RegionID;
+            ret.SessionID = data.SessionID;
+
+            return ret;
+        }
+
+        public PresenceInfo GetAgentByUser(UUID userID)
+        {
+            PresenceInfo ret = new PresenceInfo();
+
+            PresenceData data = m_Database.GetByUser(userID);
+            if (data == null)
+                return null;
+
+            ret.UserID = data.UserID;
+            ret.RegionID = data.RegionID;
+            ret.SessionID = data.SessionID;
 
             return ret;
         }
@@ -169,6 +185,7 @@ namespace OpenSim.Services.PresenceService
 
                     ret.UserID = d.UserID;
                     ret.RegionID = d.RegionID;
+                    ret.SessionID = d.SessionID;
 
                     info.Add(ret);
                 }