HG: Instant Message working. Tested on HG standalones only. Needs a lot more testing.

6 files changed, 522 insertions, 0 deletions

diff --git a/OpenSim/Services/Connectors/Hypergrid/UserAgentServiceConnector.cs b/OpenSim/Services/Connectors/Hypergrid/UserAgentServiceConnector.cs
index 265bacf..50036b3 100644
--- a/OpenSim/Services/Connectors/Hypergrid/UserAgentServiceConnector.cs
+++ b/OpenSim/Services/Connectors/Hypergrid/UserAgentServiceConnector.cs
@@ -560,6 +560,64 @@ namespace OpenSim.Services.Connectors.Hypergrid
             return serverURLs;
         }
 
+        public string LocateUser(UUID userID)
+        {
+            Hashtable hash = new Hashtable();
+            hash["userID"] = userID.ToString();
+
+            IList paramList = new ArrayList();
+            paramList.Add(hash);
+
+            XmlRpcRequest request = new XmlRpcRequest("locate_user", paramList);
+            string reason = string.Empty;
+
+            // Send and get reply
+            string url = string.Empty;
+            XmlRpcResponse response = null;
+            try
+            {
+                response = request.Send(m_ServerURL, 10000);
+            }
+            catch (Exception e)
+            {
+                m_log.DebugFormat("[USER AGENT CONNECTOR]: Unable to contact remote server {0}", m_ServerURL);
+                reason = "Exception: " + e.Message;
+                return url;
+            }
+
+            if (response.IsFault)
+            {
+                m_log.ErrorFormat("[USER AGENT CONNECTOR]: remote call to {0} returned an error: {1}", m_ServerURL, response.FaultString);
+                reason = "XMLRPC Fault";
+                return url;
+            }
+
+            hash = (Hashtable)response.Value;
+            //foreach (Object o in hash)
+            //    m_log.Debug(">> " + ((DictionaryEntry)o).Key + ":" + ((DictionaryEntry)o).Value);
+            try
+            {
+                if (hash == null)
+                {
+                    m_log.ErrorFormat("[USER AGENT CONNECTOR]: LocateUser Got null response from {0}! THIS IS BAAAAD", m_ServerURL);
+                    reason = "Internal error 1";
+                    return url;
+                }
+
+                // Here's the actual response
+                if (hash.ContainsKey("URL"))
+                    url = hash["URL"].ToString();
+
+            }
+            catch (Exception e)
+            {
+                m_log.ErrorFormat("[USER AGENT CONNECTOR]: Got exception on LocateUser response.");
+                reason = "Exception: " + e.Message;
+            }
+
+            return url;
+        }
+
         private bool GetBoolResponse(XmlRpcRequest request, out string reason)
         {
             //m_log.Debug("[USER AGENT CONNECTOR]: GetBoolResponse from/to " + m_ServerURL);
diff --git a/OpenSim/Services/Connectors/InstantMessage/InstantMessageServiceConnector.cs b/OpenSim/Services/Connectors/InstantMessage/InstantMessageServiceConnector.cs
new file mode 100644
index 0000000..65ee7c7
--- /dev/null
+++ b/OpenSim/Services/Connectors/InstantMessage/InstantMessageServiceConnector.cs
@@ -0,0 +1,129 @@
+/*
+ * 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;
+using System.Collections.Generic;
+using System.Net;
+using System.Reflection;
+
+using OpenMetaverse;
+using Nwc.XmlRpc;
+using log4net;
+
+using OpenSim.Framework;
+
+namespace OpenSim.Services.Connectors.InstantMessage
+{
+    public class InstantMessageServiceConnector
+    {
+        private static readonly ILog m_log =
+            LogManager.GetLogger(
+            MethodBase.GetCurrentMethod().DeclaringType);
+
+        /// <summary>
+        /// This actually does the XMLRPC Request
+        /// </summary>
+        /// <param name="url">URL we pull the data out of to send the request to</param>
+        /// <param name="im">The Instant Message </param>
+        /// <returns>Bool if the message was successfully delivered at the other side.</returns>
+        public static bool SendInstantMessage(string url, GridInstantMessage im)
+        {
+            Hashtable xmlrpcdata = ConvertGridInstantMessageToXMLRPC(im);
+            xmlrpcdata["region_handle"] = 0;
+
+            ArrayList SendParams = new ArrayList();
+            SendParams.Add(xmlrpcdata);
+            XmlRpcRequest GridReq = new XmlRpcRequest("grid_instant_message", SendParams);
+            try
+            {
+
+                XmlRpcResponse GridResp = GridReq.Send(url, 3000);
+
+                Hashtable responseData = (Hashtable)GridResp.Value;
+
+                if (responseData.ContainsKey("success"))
+                {
+                    if ((string)responseData["success"] == "TRUE")
+                    {
+                        m_log.DebugFormat("[XXX] Success");
+                        return true;
+                    }
+                    else
+                    {
+                        m_log.DebugFormat("[XXX] Fail");
+                        return false;
+                    }
+                }
+                else
+                {
+                    return false;
+                }
+            }
+            catch (WebException e)
+            {
+                m_log.ErrorFormat("[GRID INSTANT MESSAGE]: Error sending message to {0} the host didn't respond " + e.ToString(), url);
+            }
+
+            return false;
+        }
+
+        /// <summary>
+        /// Takes a GridInstantMessage and converts it into a Hashtable for XMLRPC
+        /// </summary>
+        /// <param name="msg">The GridInstantMessage object</param>
+        /// <returns>Hashtable containing the XMLRPC request</returns>
+        protected static Hashtable ConvertGridInstantMessageToXMLRPC(GridInstantMessage msg)
+        {
+            Hashtable gim = new Hashtable();
+            gim["from_agent_id"] = msg.fromAgentID.ToString();
+            // Kept for compatibility
+            gim["from_agent_session"] = UUID.Zero.ToString();
+            gim["to_agent_id"] = msg.toAgentID.ToString();
+            gim["im_session_id"] = msg.imSessionID.ToString();
+            gim["timestamp"] = msg.timestamp.ToString();
+            gim["from_agent_name"] = msg.fromAgentName;
+            gim["message"] = msg.message;
+            byte[] dialogdata = new byte[1]; dialogdata[0] = msg.dialog;
+            gim["dialog"] = Convert.ToBase64String(dialogdata, Base64FormattingOptions.None);
+
+            if (msg.fromGroup)
+                gim["from_group"] = "TRUE";
+            else
+                gim["from_group"] = "FALSE";
+            byte[] offlinedata = new byte[1]; offlinedata[0] = msg.offline;
+            gim["offline"] = Convert.ToBase64String(offlinedata, Base64FormattingOptions.None);
+            gim["parent_estate_id"] = msg.ParentEstateID.ToString();
+            gim["position_x"] = msg.Position.X.ToString();
+            gim["position_y"] = msg.Position.Y.ToString();
+            gim["position_z"] = msg.Position.Z.ToString();
+            gim["region_id"] = msg.RegionID.ToString();
+            gim["binary_bucket"] = Convert.ToBase64String(msg.binaryBucket, Base64FormattingOptions.None);
+            return gim;
+        }
+
+    }
+}
diff --git a/OpenSim/Services/HypergridService/HGInstantMessageService.cs b/OpenSim/Services/HypergridService/HGInstantMessageService.cs
new file mode 100644
index 0000000..6178ca1
--- /dev/null
+++ b/OpenSim/Services/HypergridService/HGInstantMessageService.cs
@@ -0,0 +1,311 @@
+/*
+ * 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 System.Net;
+using System.Reflection;
+
+using OpenSim.Framework;
+using OpenSim.Services.Connectors.Friends;
+using OpenSim.Services.Connectors.Hypergrid;
+using OpenSim.Services.Interfaces;
+using OpenSim.Services.Connectors.InstantMessage;
+using GridRegion = OpenSim.Services.Interfaces.GridRegion;
+using OpenSim.Server.Base;
+using FriendInfo = OpenSim.Services.Interfaces.FriendInfo;
+
+using OpenMetaverse;
+using log4net;
+using Nini.Config;
+
+namespace OpenSim.Services.HypergridService
+{
+    /// <summary>
+    /// Inter-grid IM
+    /// </summary>
+    public class HGInstantMessageService : IInstantMessage
+    {
+        private static readonly ILog m_log =
+                LogManager.GetLogger(
+                MethodBase.GetCurrentMethod().DeclaringType);
+
+        private const double CACHE_EXPIRATION_SECONDS = 120000.0; // 33 hours
+
+        static bool m_Initialized = false;
+
+        protected static IGridService m_GridService;
+        protected static IPresenceService m_PresenceService;
+        protected static IUserAgentService m_UserAgentService;
+
+        protected static IInstantMessageSimConnector m_IMSimConnector;
+
+        protected Dictionary<UUID, object> m_UserLocationMap = new Dictionary<UUID, object>();
+        private ExpiringCache<UUID, GridRegion> m_RegionCache;
+
+        public HGInstantMessageService(IConfigSource config)
+            : this(config, null)
+        {
+        }
+
+        public HGInstantMessageService(IConfigSource config, IInstantMessageSimConnector imConnector)
+        {
+            if (imConnector != null)
+                m_IMSimConnector = imConnector;
+
+            if (!m_Initialized)
+            {
+                m_Initialized = true;
+
+                m_log.DebugFormat("[HG IM SERVICE]: Starting...");
+
+                IConfig serverConfig = config.Configs["HGInstantMessageService"];
+                if (serverConfig == null)
+                    throw new Exception(String.Format("No section HGInstantMessageService in config file"));
+
+                string gridService = serverConfig.GetString("GridService", String.Empty);
+                string presenceService = serverConfig.GetString("PresenceService", String.Empty);
+                string userAgentService = serverConfig.GetString("UserAgentService", String.Empty);
+
+                if (gridService == string.Empty || presenceService == string.Empty)
+                    throw new Exception(String.Format("Incomplete specifications, InstantMessage Service cannot function."));
+
+                Object[] args = new Object[] { config };
+                m_GridService = ServerUtils.LoadPlugin<IGridService>(gridService, args);
+                m_PresenceService = ServerUtils.LoadPlugin<IPresenceService>(presenceService, args);
+                m_UserAgentService = ServerUtils.LoadPlugin<IUserAgentService>(userAgentService, args);
+
+                m_RegionCache = new ExpiringCache<UUID, GridRegion>();
+
+            }
+        }
+
+        public bool IncomingInstantMessage(GridInstantMessage im)
+        {
+            m_log.DebugFormat("[HG IM SERVICE]: Received message {0} from {1} to {2}", im.message, im.fromAgentID, im.toAgentID);
+            UUID toAgentID = new UUID(im.toAgentID);
+
+            if (m_IMSimConnector != null)
+            {
+                m_log.DebugFormat("[XXX] SendIMToRegion local im connector");
+                return m_IMSimConnector.SendInstantMessage(im);
+            }
+            else
+                return TrySendInstantMessage(im, "", true); 
+        }
+
+        public bool OutgoingInstantMessage(GridInstantMessage im, string url)
+        {
+            m_log.DebugFormat("[HG IM SERVICE]: Sending message {0} from {1} to {2}@{3}", im.message, im.fromAgentID, im.toAgentID, url);
+            if (url != string.Empty)
+                return TrySendInstantMessage(im, url, true);
+            else
+            {
+                PresenceInfo upd = new PresenceInfo();
+                upd.RegionID = UUID.Zero;
+                return TrySendInstantMessage(im, upd, true);
+            }
+        }
+
+        protected bool TrySendInstantMessage(GridInstantMessage im, object previousLocation, bool firstTime)
+        {
+            UUID toAgentID = new UUID(im.toAgentID);
+
+            PresenceInfo upd = null;
+            string url = string.Empty;
+
+            bool lookupAgent = false;
+
+            lock (m_UserLocationMap)
+            {
+                if (m_UserLocationMap.ContainsKey(toAgentID))
+                {
+                    object o = m_UserLocationMap[toAgentID];
+                    if (o is PresenceInfo)
+                        upd = (PresenceInfo)o;
+                    else if (o is string)
+                        url = (string)o;
+
+                    // We need to compare the current location with the previous 
+                    // or the recursive loop will never end because it will never try to lookup the agent again
+                    if (!firstTime)
+                    {
+                        lookupAgent = true;
+                    }
+                }
+                else
+                {
+                    lookupAgent = true;
+                }
+            }
+
+            m_log.DebugFormat("[XXX] Neeed lookup ? {0}", (lookupAgent ? "yes" : "no"));
+
+            // Are we needing to look-up an agent?
+            if (lookupAgent)
+            {
+                bool isPresent = false;
+                // Non-cached user agent lookup.
+                PresenceInfo[] presences = m_PresenceService.GetAgents(new string[] { toAgentID.ToString() });
+                if (presences != null && presences.Length > 0)
+                {
+                    foreach (PresenceInfo p in presences)
+                    {
+                        if (p.RegionID != UUID.Zero)
+                        {
+                            upd = p;
+                            break;
+                        }
+                        else
+                            isPresent = true;
+                    }
+                }
+
+                if (upd == null && isPresent)
+                {
+                    // Let's check with the UAS if the user is elsewhere
+                    url = m_UserAgentService.LocateUser(toAgentID);
+                }
+
+                if (upd != null || url != string.Empty)
+                {
+                    // check if we've tried this before..
+                    // This is one way to end the recursive loop
+                    //
+                    if (!firstTime && ((previousLocation is PresenceInfo && upd != null && upd.RegionID == ((PresenceInfo)previousLocation).RegionID) ||
+                                       (previousLocation is string && previousLocation.Equals(url))))
+                    {
+                        // m_log.Error("[GRID INSTANT MESSAGE]: Unable to deliver an instant message");
+                        m_log.DebugFormat("[XXX] Fail 1 {0} {1}", previousLocation, url);
+
+                        return false;
+                    }
+                }
+            }
+
+            if (upd != null)
+            {
+                // ok, the user is around somewhere. Let's send back the reply with "success"
+                // even though the IM may still fail. Just don't keep the caller waiting for
+                // the entire time we're trying to deliver the IM
+                return SendIMToRegion(upd, im, toAgentID);
+            }
+            else if (url != string.Empty)
+            {
+                // ok, the user is around somewhere. Let's send back the reply with "success"
+                // even though the IM may still fail. Just don't keep the caller waiting for
+                // the entire time we're trying to deliver the IM
+                return ForwardIMToGrid(url, im, toAgentID);
+            }
+            else if (firstTime && previousLocation is string && (string)previousLocation != string.Empty)
+            {
+                return ForwardIMToGrid((string)previousLocation, im, toAgentID);
+            }
+            else
+                m_log.DebugFormat("[HG IM SERVICE]: Unable to locate user {0}", toAgentID);
+            return false;
+        }
+
+        bool SendIMToRegion(PresenceInfo upd, GridInstantMessage im, UUID toAgentID)
+        {
+            bool imresult = false;
+            GridRegion reginfo = null;
+            if (!m_RegionCache.TryGetValue(upd.RegionID, out reginfo))
+            {
+                reginfo = m_GridService.GetRegionByUUID(UUID.Zero /*!!!*/, upd.RegionID);
+                if (reginfo != null)
+                    m_RegionCache.AddOrUpdate(upd.RegionID, reginfo, CACHE_EXPIRATION_SECONDS);
+            }
+
+            if (reginfo != null)
+                imresult = InstantMessageServiceConnector.SendInstantMessage(reginfo.ServerURI, im);
+            else
+                return false;
+
+            if (imresult)
+            {
+                // IM delivery successful, so store the Agent's location in our local cache.
+                lock (m_UserLocationMap)
+                {
+                    if (m_UserLocationMap.ContainsKey(toAgentID))
+                    {
+                        m_UserLocationMap[toAgentID] = upd;
+                    }
+                    else
+                    {
+                        m_UserLocationMap.Add(toAgentID, upd);
+                    }
+                }
+                return true;
+            }
+            else
+            {
+                // 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!!!!!
+                return TrySendInstantMessage(im, upd, false);
+            }
+        }
+
+        bool ForwardIMToGrid(string url, GridInstantMessage im, UUID toAgentID)
+        {
+            if (InstantMessageServiceConnector.SendInstantMessage(url, im))
+            {
+                // IM delivery successful, so store the Agent's location in our local cache.
+                lock (m_UserLocationMap)
+                {
+                    if (m_UserLocationMap.ContainsKey(toAgentID))
+                    {
+                        m_UserLocationMap[toAgentID] = url;
+                    }
+                    else
+                    {
+                        m_UserLocationMap.Add(toAgentID, url);
+                    }
+                }
+
+                return true;
+            }
+            else
+            {
+                // 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!!!!!
+                return TrySendInstantMessage(im, url, false);
+            }
+
+        }
+    }
+}
diff --git a/OpenSim/Services/HypergridService/UserAgentService.cs b/OpenSim/Services/HypergridService/UserAgentService.cs
index e63f941..59ad043 100644
--- a/OpenSim/Services/HypergridService/UserAgentService.cs
+++ b/OpenSim/Services/HypergridService/UserAgentService.cs
@@ -474,6 +474,17 @@ namespace OpenSim.Services.HypergridService
 
             return new Dictionary<string, object>();
         }
+
+        public string LocateUser(UUID userID)
+        {
+            foreach (TravelingAgentInfo t in m_TravelingAgents.Values)
+            {
+                if (t.UserID == userID)
+                    return t.GridExternalName;
+            }
+
+            return string.Empty;
+        }
     }
 
     class TravelingAgentInfo
diff --git a/OpenSim/Services/Interfaces/IGatekeeperService.cs b/OpenSim/Services/Interfaces/IGatekeeperService.cs
index f1860cc..ffab9ea 100644
--- a/OpenSim/Services/Interfaces/IGatekeeperService.cs
+++ b/OpenSim/Services/Interfaces/IGatekeeperService.cs
@@ -56,6 +56,8 @@ namespace OpenSim.Services.Interfaces
         GridRegion GetHomeRegion(UUID userID, out Vector3 position, out Vector3 lookAt);
         Dictionary<string, object> GetServerURLs(UUID userID);
 
+        string LocateUser(UUID userID);
+
         void StatusNotification(List<string> friends, UUID userID, bool online);
         List<UUID> GetOnlineFriends(UUID userID, List<string> friends);
 
@@ -63,4 +65,10 @@ namespace OpenSim.Services.Interfaces
         bool VerifyAgent(UUID sessionID, string token);
         bool VerifyClient(UUID sessionID, string reportedIP);
     }
+
+    public interface IInstantMessage
+    {
+        bool IncomingInstantMessage(GridInstantMessage im);
+        bool OutgoingInstantMessage(GridInstantMessage im, string url);
+    }
 }
diff --git a/OpenSim/Services/Interfaces/ISimulatorSocialService.cs b/OpenSim/Services/Interfaces/ISimulatorSocialService.cs
index 0b7aefc..df9e7e7 100644
--- a/OpenSim/Services/Interfaces/ISimulatorSocialService.cs
+++ b/OpenSim/Services/Interfaces/ISimulatorSocialService.cs
@@ -37,4 +37,9 @@ namespace OpenSim.Services.Interfaces
     {
         bool StatusNotify(UUID userID, UUID friendID, bool online);
     }
+
+    public interface IInstantMessageSimConnector
+    {
+        bool SendInstantMessage(GridInstantMessage im);
+    }
 }