If calls to UserAgentServiceConnector fail then throw an exception. This lets the caller decide whether to discard the error or not.

This is Oren Hurvitz's 0001 patch from http://opensimulator.org/mantis/view.php?id=6956 but I ended up doing some tweaking to resolve patch application issues.

3 files changed, 139 insertions, 294 deletions

diff --git a/OpenSim/Services/Connectors/Hypergrid/UserAgentServiceConnector.cs b/OpenSim/Services/Connectors/Hypergrid/UserAgentServiceConnector.cs
index 2511c08..cbd62cb 100644
--- a/OpenSim/Services/Connectors/Hypergrid/UserAgentServiceConnector.cs
+++ b/OpenSim/Services/Connectors/Hypergrid/UserAgentServiceConnector.cs
@@ -78,7 +78,8 @@ namespace OpenSim.Services.Connectors.Hypergrid
                     m_log.DebugFormat("[USER AGENT CONNECTOR]: Malformed Uri {0}: {1}", m_ServerURL, e.Message);
                 }
             }
-            m_log.DebugFormat("[USER AGENT CONNECTOR]: new connector to {0} ({1})", url, m_ServerURL);
+
+            //m_log.DebugFormat("[USER AGENT CONNECTOR]: new connector to {0} ({1})", url, m_ServerURL);
         }
 
         public UserAgentServiceConnector(IConfigSource config)
@@ -190,96 +191,99 @@ namespace OpenSim.Services.Connectors.Hypergrid
             // no-op
         }
 
-        public GridRegion GetHomeRegion(UUID userID, out Vector3 position, out Vector3 lookAt)
+        private Hashtable CallServer(string methodName, Hashtable hash)
         {
-            position = Vector3.UnitY; lookAt = Vector3.UnitY;
-
-            Hashtable hash = new Hashtable();
-            hash["userID"] = userID.ToString();
-
             IList paramList = new ArrayList();
             paramList.Add(hash);
 
-            XmlRpcRequest request = new XmlRpcRequest("get_home_region", paramList);
+            XmlRpcRequest request = new XmlRpcRequest(methodName, paramList);
+
+            // Send and get reply
             XmlRpcResponse response = null;
             try
             {
                 response = request.Send(m_ServerURL, 10000);
             }
-            catch (Exception)
+            catch (Exception e)
             {
-                return null;
+                m_log.WarnFormat("[USER AGENT CONNECTOR]: {0} call to {1} failed: {2}", methodName, m_ServerURL, e.Message);
+                throw;
             }
 
             if (response.IsFault)
             {
-                return null;
+                throw new Exception(string.Format("[USER AGENT CONNECTOR]: {0} call to {1} returned an error: {2}", methodName, m_ServerURL, response.FaultString));
             }
 
             hash = (Hashtable)response.Value;
-            //foreach (Object o in hash)
-            //    m_log.Debug(">> " + ((DictionaryEntry)o).Key + ":" + ((DictionaryEntry)o).Value);
-            try
+
+            if (hash == null)
             {
-                bool success = false;
-                Boolean.TryParse((string)hash["result"], out success);
-                if (success)
-                {
-                    GridRegion region = new GridRegion();
+                throw new Exception(string.Format("[USER AGENT CONNECTOR]: {0} call to {1} returned null", methodName, m_ServerURL));
+            }
 
-                    UUID.TryParse((string)hash["uuid"], out region.RegionID);
-                    //m_log.Debug(">> HERE, uuid: " + region.RegionID);
-                    int n = 0;
-                    if (hash["x"] != null)
-                    {
-                        Int32.TryParse((string)hash["x"], out n);
-                        region.RegionLocX = n;
-                        //m_log.Debug(">> HERE, x: " + region.RegionLocX);
-                    }
-                    if (hash["y"] != null)
-                    {
-                        Int32.TryParse((string)hash["y"], out n);
-                        region.RegionLocY = n;
-                        //m_log.Debug(">> HERE, y: " + region.RegionLocY);
-                    }
-                    if (hash["region_name"] != null)
-                    {
-                        region.RegionName = (string)hash["region_name"];
-                        //m_log.Debug(">> HERE, name: " + region.RegionName);
-                    }
-                    if (hash["hostname"] != null)
-                        region.ExternalHostName = (string)hash["hostname"];
-                    if (hash["http_port"] != null)
-                    {
-                        uint p = 0;
-                        UInt32.TryParse((string)hash["http_port"], out p);
-                        region.HttpPort = p;
-                    }
-                    if (hash.ContainsKey("server_uri") && hash["server_uri"] != null)
-                        region.ServerURI = (string)hash["server_uri"];
+            return hash;
+        }
 
-                    if (hash["internal_port"] != null)
-                    {
-                        int p = 0;
-                        Int32.TryParse((string)hash["internal_port"], out p);
-                        region.InternalEndPoint = new IPEndPoint(IPAddress.Parse("0.0.0.0"), p);
-                    }
-                    if (hash["position"] != null)
-                        Vector3.TryParse((string)hash["position"], out position);
-                    if (hash["lookAt"] != null)
-                        Vector3.TryParse((string)hash["lookAt"], out lookAt);
+        public GridRegion GetHomeRegion(UUID userID, out Vector3 position, out Vector3 lookAt)
+        {
+            position = Vector3.UnitY; lookAt = Vector3.UnitY;
 
-                    // Successful return
-                    return region;
-                }
+            Hashtable hash = new Hashtable();
+            hash["userID"] = userID.ToString();
 
+            hash = CallServer("get_home_region", hash);
+
+            bool success;
+            if (!Boolean.TryParse((string)hash["result"], out success) || !success)
+                return null;
+
+            GridRegion region = new GridRegion();
+
+            UUID.TryParse((string)hash["uuid"], out region.RegionID);
+            //m_log.Debug(">> HERE, uuid: " + region.RegionID);
+            int n = 0;
+            if (hash["x"] != null)
+            {
+                Int32.TryParse((string)hash["x"], out n);
+                region.RegionLocX = n;
+                //m_log.Debug(">> HERE, x: " + region.RegionLocX);
             }
-            catch (Exception)
+            if (hash["y"] != null)
             {
-                return null;
+                Int32.TryParse((string)hash["y"], out n);
+                region.RegionLocY = n;
+                //m_log.Debug(">> HERE, y: " + region.RegionLocY);
+            }
+            if (hash["region_name"] != null)
+            {
+                region.RegionName = (string)hash["region_name"];
+                //m_log.Debug(">> HERE, name: " + region.RegionName);
             }
+            if (hash["hostname"] != null)
+                region.ExternalHostName = (string)hash["hostname"];
+            if (hash["http_port"] != null)
+            {
+                uint p = 0;
+                UInt32.TryParse((string)hash["http_port"], out p);
+                region.HttpPort = p;
+            }
+            if (hash.ContainsKey("server_uri") && hash["server_uri"] != null)
+                region.ServerURI = (string)hash["server_uri"];
 
-            return null;
+            if (hash["internal_port"] != null)
+            {
+                int p = 0;
+                Int32.TryParse((string)hash["internal_port"], out p);
+                region.InternalEndPoint = new IPEndPoint(IPAddress.Parse("0.0.0.0"), p);
+            }
+            if (hash["position"] != null)
+                Vector3.TryParse((string)hash["position"], out position);
+            if (hash["lookAt"] != null)
+                Vector3.TryParse((string)hash["lookAt"], out lookAt);
+
+            // Successful return
+            return region;
         }
 
         public bool IsAgentComingHome(UUID sessionID, string thisGridExternalName)
@@ -488,51 +492,17 @@ namespace OpenSim.Services.Connectors.Hypergrid
             Hashtable hash = new Hashtable();
             hash["userID"] = userID.ToString();
 
-            IList paramList = new ArrayList();
-            paramList.Add(hash);
-
-            XmlRpcRequest request = new XmlRpcRequest("get_user_info", paramList);
+            hash = CallServer("get_user_info", hash);
 
             Dictionary<string, object> info = new Dictionary<string, object>();
-            XmlRpcResponse response = null;
-            try
-            {
-                response = request.Send(m_ServerURL, 10000);
-            }
-            catch
-            {
-                m_log.DebugFormat("[USER AGENT CONNECTOR]: Unable to contact remote server {0} for GetUserInfo", m_ServerURL);
-                return info;
-            }
-
-            if (response.IsFault)
-            {
-                m_log.ErrorFormat("[USER AGENT CONNECTOR]: remote call to {0} for GetServerURLs returned an error: {1}", m_ServerURL, response.FaultString);
-                return info;
-            }
 
-            hash = (Hashtable)response.Value;
-            try
+            foreach (object key in hash.Keys)
             {
-                if (hash == null)
+                if (hash[key] != null)
                 {
-                    m_log.ErrorFormat("[USER AGENT CONNECTOR]: GetUserInfo Got null response from {0}! THIS IS BAAAAD", m_ServerURL);
-                    return info;
-                }
-
-                // Here is the actual response
-                foreach (object key in hash.Keys)
-                {
-                    if (hash[key] != null)
-                    {
-                        info.Add(key.ToString(), hash[key]);
-                    }
+                    info.Add(key.ToString(), hash[key]);
                 }
             }
-            catch
-            {
-                m_log.ErrorFormat("[USER AGENT CONNECTOR]: Got exception on GetOnlineFriends response.");
-            }
 
             return info;
         }
@@ -542,60 +512,16 @@ namespace OpenSim.Services.Connectors.Hypergrid
             Hashtable hash = new Hashtable();
             hash["userID"] = userID.ToString();
 
-            IList paramList = new ArrayList();
-            paramList.Add(hash);
-
-            XmlRpcRequest request = new XmlRpcRequest("get_server_urls", paramList);
-//            string reason = string.Empty;
-
-            // Send and get reply
-            Dictionary<string, object> serverURLs = new Dictionary<string,object>();
-            XmlRpcResponse response = null;
-            try
-            {
-                response = request.Send(m_ServerURL, 10000);
-            }
-            catch
-            {
-                m_log.DebugFormat("[USER AGENT CONNECTOR]: Unable to contact remote server {0} for GetServerURLs for user {1}", m_ServerURL, userID);
-//                reason = "Exception: " + e.Message;
-                return serverURLs;
-            }
-
-            if (response.IsFault)
+            hash = CallServer("get_server_urls", hash);
+           
+            Dictionary<string, object> serverURLs = new Dictionary<string, object>();
+            foreach (object key in hash.Keys)
             {
-                m_log.ErrorFormat("[USER AGENT CONNECTOR]: remote call to {0} for GetServerURLs returned an error: {1}", m_ServerURL, response.FaultString);
-//                reason = "XMLRPC Fault";
-                return serverURLs;
-            }
-
-            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]: GetServerURLs Got null response from {0}! THIS IS BAAAAD", m_ServerURL);
-//                    reason = "Internal error 1";
-                    return serverURLs;
-                }
-
-                // Here is the actual response
-                foreach (object key in hash.Keys)
+                if (key is string && ((string)key).StartsWith("SRV_") && hash[key] != null)
                 {
-                    if (key is string && ((string)key).StartsWith("SRV_") && hash[key] != null)
-                    {
-                        string serverType = key.ToString().Substring(4); // remove "SRV_"
-                        serverURLs.Add(serverType, hash[key].ToString());
-                    }
+                    string serverType = key.ToString().Substring(4); // remove "SRV_"
+                    serverURLs.Add(serverType, hash[key].ToString());
                 }
-
-            }
-            catch
-            {
-                m_log.ErrorFormat("[USER AGENT CONNECTOR]: Got exception on GetOnlineFriends response.");
-//                reason = "Exception: " + e.Message;
             }
 
             return serverURLs;
@@ -606,55 +532,13 @@ namespace OpenSim.Services.Connectors.Hypergrid
             Hashtable hash = new Hashtable();
             hash["userID"] = userID.ToString();
 
-            IList paramList = new ArrayList();
-            paramList.Add(hash);
+            hash = CallServer("locate_user", 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
-            {
-                m_log.DebugFormat("[USER AGENT CONNECTOR]: Unable to contact remote server {0} for LocateUser", m_ServerURL);
-//                reason = "Exception: " + e.Message;
-                return url;
-            }
-
-            if (response.IsFault)
-            {
-                m_log.ErrorFormat("[USER AGENT CONNECTOR]: remote call to {0} for LocateUser 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
-            {
-                m_log.ErrorFormat("[USER AGENT CONNECTOR]: Got exception on LocateUser response.");
-//                reason = "Exception: " + e.Message;
-            }
+            // Here's the actual response
+            if (hash.ContainsKey("URL"))
+                url = hash["URL"].ToString();
 
             return url;
         }
@@ -665,55 +549,13 @@ namespace OpenSim.Services.Connectors.Hypergrid
             hash["userID"] = userID.ToString();
             hash["targetUserID"] = targetUserID.ToString();
 
-            IList paramList = new ArrayList();
-            paramList.Add(hash);
+            hash = CallServer("get_uui", hash);
 
-            XmlRpcRequest request = new XmlRpcRequest("get_uui", paramList);
-//            string reason = string.Empty;
-
-            // Send and get reply
             string uui = string.Empty;
-            XmlRpcResponse response = null;
-            try
-            {
-                response = request.Send(m_ServerURL, 10000);
-            }
-            catch
-            {
-                m_log.DebugFormat("[USER AGENT CONNECTOR]: Unable to contact remote server {0} for GetUUI", m_ServerURL);
-//                reason = "Exception: " + e.Message;
-                return uui;
-            }
-
-            if (response.IsFault)
-            {
-                m_log.ErrorFormat("[USER AGENT CONNECTOR]: remote call to {0} for GetUUI returned an error: {1}", m_ServerURL, response.FaultString);
-//                reason = "XMLRPC Fault";
-                return uui;
-            }
 
-            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]: GetUUI Got null response from {0}! THIS IS BAAAAD", m_ServerURL);
-//                    reason = "Internal error 1";
-                    return uui;
-                }
-
-                // Here's the actual response
-                if (hash.ContainsKey("UUI"))
-                    uui = hash["UUI"].ToString();
-
-            }
-            catch
-            {
-                m_log.ErrorFormat("[USER AGENT CONNECTOR]: Got exception on GetUUI response.");
-//                reason = "Exception: " + e.Message;
-            }
+            // Here's the actual response
+            if (hash.ContainsKey("UUI"))
+                uui = hash["UUI"].ToString();
 
             return uui;
         }
@@ -724,54 +566,17 @@ namespace OpenSim.Services.Connectors.Hypergrid
             hash["first"] = first;
             hash["last"] = last;
 
-            IList paramList = new ArrayList();
-            paramList.Add(hash);
-
-            XmlRpcRequest request = new XmlRpcRequest("get_uuid", paramList);
-            //            string reason = string.Empty;
-
-            // Send and get reply
-            UUID uuid = UUID.Zero;
-            XmlRpcResponse response = null;
-            try
-            {
-                response = request.Send(m_ServerURL, 10000);
-            }
-            catch
-            {
-                m_log.DebugFormat("[USER AGENT CONNECTOR]: Unable to contact remote server {0} for GetUUID", m_ServerURL);
-                //                reason = "Exception: " + e.Message;
-                return uuid;
-            }
+            hash = CallServer("get_uuid", hash);
 
-            if (response.IsFault)
+            if (!hash.ContainsKey("UUID"))
             {
-                m_log.ErrorFormat("[USER AGENT CONNECTOR]: remote call to {0} for GetUUID returned an error: {1}", m_ServerURL, response.FaultString);
-                //                reason = "XMLRPC Fault";
-                return uuid;
+                throw new Exception(string.Format("[USER AGENT CONNECTOR]: get_uuid call to {0} didn't return a UUID", m_ServerURL));
             }
 
-            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]: GetUUDI Got null response from {0}! THIS IS BAAAAD", m_ServerURL);
-                    //                    reason = "Internal error 1";
-                    return uuid;
-                }
-
-                // Here's the actual response
-                if (hash.ContainsKey("UUID"))
-                    UUID.TryParse(hash["UUID"].ToString(), out uuid);
-
-            }
-            catch
+            UUID uuid;
+            if (!UUID.TryParse(hash["UUID"].ToString(), out uuid))
             {
-                m_log.ErrorFormat("[USER AGENT CONNECTOR]: Got exception on UUID response.");
-                //                reason = "Exception: " + e.Message;
+                throw new Exception(string.Format("[USER AGENT CONNECTOR]: get_uuid call to {0} returned an invalid UUID: {1}", m_ServerURL, hash["UUID"].ToString()));
             }
 
             return uuid;
diff --git a/OpenSim/Services/HypergridService/HGInstantMessageService.cs b/OpenSim/Services/HypergridService/HGInstantMessageService.cs
index e8d7cca..9b7b278 100644
--- a/OpenSim/Services/HypergridService/HGInstantMessageService.cs
+++ b/OpenSim/Services/HypergridService/HGInstantMessageService.cs
@@ -215,7 +215,15 @@ namespace OpenSim.Services.HypergridService
                 {
                     // Let's check with the UAS if the user is elsewhere
                     m_log.DebugFormat("[HG IM SERVICE]: User is not present. Checking location with User Agent service");
-                    url = m_UserAgentService.LocateUser(toAgentID);
+                    try
+                    {
+                        url = m_UserAgentService.LocateUser(toAgentID);
+                    }
+                    catch (Exception e)
+                    {
+                        m_log.Warn("[HG IM SERVICE]: LocateUser call failed ", e);
+                        url = string.Empty;
+                    }
                 }
 
                 // check if we've tried this before..
diff --git a/OpenSim/Services/Interfaces/IHypergridServices.cs b/OpenSim/Services/Interfaces/IHypergridServices.cs
index 05e175a..bece4c7 100644
--- a/OpenSim/Services/Interfaces/IHypergridServices.cs
+++ b/OpenSim/Services/Interfaces/IHypergridServices.cs
@@ -1,4 +1,4 @@
-/*
+/*
  * Copyright (c) Contributors, http://opensimulator.org/
  * See CONTRIBUTORS.TXT for a full list of copyright holders.
  *
@@ -47,15 +47,47 @@ namespace OpenSim.Services.Interfaces
     {
         bool LoginAgentToGrid(AgentCircuitData agent, GridRegion gatekeeper, GridRegion finalDestination, bool fromLogin, out string reason);
         void LogoutAgent(UUID userID, UUID sessionID);
+
+        /// <summary>
+        /// Returns the home region of a remote user.
+        /// </summary>
+        /// <returns>On success: the user's home region. If the user doesn't exist: null.</returns>
+        /// <remarks>Throws an exception if an error occurs (e.g., can't contact the server).</remarks>
         GridRegion GetHomeRegion(UUID userID, out Vector3 position, out Vector3 lookAt);
+
+        /// <summary>
+        /// Returns the Server URLs of a remote user.
+        /// </summary>
+        /// <returns>On success: the user's Server URLs. If the user doesn't exist: an empty dictionary.</returns>
+        /// <remarks>Throws an exception if an error occurs (e.g., can't contact the server).</remarks>
         Dictionary<string, object> GetServerURLs(UUID userID);
-        Dictionary<string,object> GetUserInfo(UUID userID);
 
+        /// <summary>
+        /// Returns the UserInfo of a remote user.
+        /// </summary>
+        /// <returns>On success: the user's UserInfo. If the user doesn't exist: an empty dictionary.</returns>
+        /// <remarks>Throws an exception if an error occurs (e.g., can't contact the server).</remarks>
+        Dictionary<string, object> GetUserInfo(UUID userID);
+
+        /// <summary>
+        /// Returns the current location of a remote user.
+        /// </summary>
+        /// <returns>On success: the user's Server URLs. If the user doesn't exist: "".</returns>
+        /// <remarks>Throws an exception if an error occurs (e.g., can't contact the server).</remarks>
         string LocateUser(UUID userID);
-        // Tries to get the universal user identifier for the targetUserId
-        // on behalf of the userID
+        
+        /// <summary>
+        /// Returns the Universal User Identifier for 'targetUserID' on behalf of 'userID'.
+        /// </summary>
+        /// <returns>On success: the user's UUI. If the user doesn't exist: "".</returns>
+        /// <remarks>Throws an exception if an error occurs (e.g., can't contact the server).</remarks>
         string GetUUI(UUID userID, UUID targetUserID);
 
+        /// <summary>
+        /// Returns the remote user that has the given name.
+        /// </summary>
+        /// <returns>On success: the user's UUID. If the user doesn't exist: UUID.Zero.</returns>
+        /// <remarks>Throws an exception if an error occurs (e.g., can't contact the server).</remarks>
         UUID GetUUID(String first, String last);
 
         // Returns the local friends online