3 files changed, 682 insertions, 25 deletions

diff --git a/OpenSim/Framework/Servers/GetAssetStreamHandler.cs b/OpenSim/Server/Handlers/Grid/GridServerConnector.cs
index c6958de..14daf12 100644
--- a/OpenSim/Framework/Servers/GetAssetStreamHandler.cs
+++ b/OpenSim/Server/Handlers/Grid/GridServerConnector.cs
@@ -26,38 +26,36 @@
  */
 
 using System;
-using System.IO;
-using System.Reflection;
-using System.Text;
-using System.Text.RegularExpressions;
-using System.Xml;
-using System.Xml.Serialization;
-using log4net;
-using OpenMetaverse;
-using OpenSim.Data;
-using OpenSim.Framework;
-using OpenSim.Framework.Servers;
+using Nini.Config;
+using OpenSim.Server.Base;
+using OpenSim.Services.Interfaces;
 using OpenSim.Framework.Servers.HttpServer;
-using OpenSim.Framework.Statistics;
-using System.Net;
+using OpenSim.Server.Handlers.Base;
 
-namespace OpenSim.Framework.Servers
+namespace OpenSim.Server.Handlers.Grid
 {
-    public class GetAssetStreamHandler : BaseGetAssetStreamHandler
+    public class GridServiceConnector : ServiceConnector
     {
-        // private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+        private IGridService m_GridService;
+        private string m_ConfigName = "GridService";
 
-        private readonly IAssetDataPlugin m_assetProvider;
-
-        public GetAssetStreamHandler(IAssetDataPlugin assetProvider)
-            : base("GET", "/assets")
+        public GridServiceConnector(IConfigSource config, IHttpServer server, string configName) :
+                base(config, server, configName)
         {
-            m_assetProvider = assetProvider;
-        }
+            IConfig serverConfig = config.Configs[m_ConfigName];
+            if (serverConfig == null)
+                throw new Exception(String.Format("No section {0} in config file", m_ConfigName));
 
-        protected override AssetBase GetAsset(UUID assetID)
-        {
-            return m_assetProvider.GetAsset(assetID);
+            string gridService = serverConfig.GetString("LocalServiceModule",
+                    String.Empty);
+
+            if (gridService == String.Empty)
+                throw new Exception("No LocalServiceModule in config file");
+
+            Object[] args = new Object[] { config };
+            m_GridService = ServerUtils.LoadPlugin<IGridService>(gridService, args);
+
+            server.AddStreamHandler(new GridServerPostHandler(m_GridService));
         }
     }
 }
diff --git a/OpenSim/Server/Handlers/Grid/GridServerPostHandler.cs b/OpenSim/Server/Handlers/Grid/GridServerPostHandler.cs
new file mode 100644
index 0000000..e22328d
--- /dev/null
+++ b/OpenSim/Server/Handlers/Grid/GridServerPostHandler.cs
@@ -0,0 +1,451 @@
+/*
+ * 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 Nini.Config;
+using log4net;
+using System;
+using System.Reflection;
+using System.IO;
+using System.Net;
+using System.Text;
+using System.Text.RegularExpressions;
+using System.Xml;
+using System.Xml.Serialization;
+using System.Collections.Generic;
+using OpenSim.Server.Base;
+using OpenSim.Services.Interfaces;
+using GridRegion = OpenSim.Services.Interfaces.GridRegion;
+using OpenSim.Framework;
+using OpenSim.Framework.Servers.HttpServer;
+using OpenMetaverse;
+
+namespace OpenSim.Server.Handlers.Grid
+{
+    public class GridServerPostHandler : BaseStreamHandler
+    {
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
+        private IGridService m_GridService;
+
+        public GridServerPostHandler(IGridService service) :
+                base("POST", "/grid")
+        {
+            m_GridService = service;
+        }
+
+        public override byte[] Handle(string path, Stream requestData,
+                OSHttpRequest httpRequest, OSHttpResponse httpResponse)
+        {
+            StreamReader sr = new StreamReader(requestData);
+            string body = sr.ReadToEnd();
+            sr.Close();
+            body = body.Trim();
+
+            //m_log.DebugFormat("[XXX]: query String: {0}", body);
+
+            Dictionary<string, string> request =
+                    ServerUtils.ParseQueryString(body);
+
+            if (!request.ContainsKey("METHOD"))
+                return FailureResult();
+
+            string method = request["METHOD"];
+
+            switch (method)
+            {
+                case "register":
+                    return Register(request);
+
+                case "deregister":
+                    return Deregister(request);
+
+                case "get_neighbours":
+                    return GetNeighbours(request);
+
+                case "get_region_by_uuid":
+                    return GetRegionByUUID(request);
+
+                case "get_region_by_position":
+                    return GetRegionByPosition(request);
+
+                case "get_region_by_name":
+                    return GetRegionByName(request);
+
+                case "get_regions_by_name":
+                    return GetRegionsByName(request);
+
+                case "get_region_range":
+                    return GetRegionRange(request);
+
+            }
+
+            m_log.DebugFormat("[GRID HANDLER]: unknown method {0} request {1}", method.Length, method);
+            return FailureResult();
+
+        }
+
+        #region Method-specific handlers
+
+        byte[] Register(Dictionary<string, string> request)
+        {
+            UUID scopeID = UUID.Zero;
+            if (request["SCOPEID"] != null)
+                UUID.TryParse(request["SCOPEID"], out scopeID);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no scopeID in request to register region");
+
+            int versionNumberMin = 0, versionNumberMax = 0;
+            if (request.ContainsKey("VERSIONMIN"))
+                Int32.TryParse(request["VERSIONMIN"], out versionNumberMin);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no minimum protocol version in request to register region");
+
+            if (request.ContainsKey("VERSIONMAX"))
+                Int32.TryParse(request["VERSIONMAX"], out versionNumberMax);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no maximum protocol version in request to register region");
+
+            // Check the protocol version
+            if ((versionNumberMin > ProtocolVersions.ServerProtocolVersionMax && versionNumberMax < ProtocolVersions.ServerProtocolVersionMax))
+            {
+                // Can't do, there is no overlap in the acceptable ranges
+                return FailureResult();
+            }
+
+            Dictionary<string, object> rinfoData = new Dictionary<string, object>();
+            foreach (KeyValuePair<string, string> kvp in request)
+                rinfoData[kvp.Key] = kvp.Value;
+            GridRegion rinfo = new GridRegion(rinfoData);
+
+            bool result = m_GridService.RegisterRegion(scopeID, rinfo);
+
+            if (result)
+                return SuccessResult();
+            else
+                return FailureResult();
+        }
+
+        byte[] Deregister(Dictionary<string, string> request)
+        {
+            UUID regionID = UUID.Zero;
+            if (request["REGIONID"] != null)
+                UUID.TryParse(request["REGIONID"], out regionID);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no regionID in request to deregister region");
+
+            bool result = m_GridService.DeregisterRegion(regionID);
+
+            if (result)
+                return SuccessResult();
+            else
+                return FailureResult();
+
+        }
+
+        byte[] GetNeighbours(Dictionary<string, string> request)
+        {
+            UUID scopeID = UUID.Zero;
+            if (request["SCOPEID"] != null)
+                UUID.TryParse(request["SCOPEID"], out scopeID);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no scopeID in request to get neighbours");
+
+            UUID regionID = UUID.Zero;
+            if (request["REGIONID"] != null)
+                UUID.TryParse(request["REGIONID"], out regionID);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no regionID in request to get neighbours");
+
+            List<GridRegion> rinfos = m_GridService.GetNeighbours(scopeID, regionID);
+            //m_log.DebugFormat("[GRID HANDLER]: neighbours for region {0}: {1}", regionID, rinfos.Count);
+
+            Dictionary<string, object> result = new Dictionary<string, object>();
+            if ((rinfos == null) || ((rinfos != null) && (rinfos.Count == 0)))
+                result["result"] = "null";
+            else
+            {
+                int i = 0;
+                foreach (GridRegion rinfo in rinfos)
+                {
+                    Dictionary<string, object> rinfoDict = rinfo.ToKeyValuePairs();
+                    result["region" + i] = rinfoDict;
+                    i++;
+                }
+            }
+
+            string xmlString = ServerUtils.BuildXmlResponse(result);
+            //m_log.DebugFormat("[GRID HANDLER]: resp string: {0}", xmlString);
+            UTF8Encoding encoding = new UTF8Encoding();
+            return encoding.GetBytes(xmlString);
+
+        }
+
+        byte[] GetRegionByUUID(Dictionary<string, string> request)
+        {
+            UUID scopeID = UUID.Zero;
+            if (request["SCOPEID"] != null)
+                UUID.TryParse(request["SCOPEID"], out scopeID);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no scopeID in request to get neighbours");
+
+            UUID regionID = UUID.Zero;
+            if (request["REGIONID"] != null)
+                UUID.TryParse(request["REGIONID"], out regionID);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no regionID in request to get neighbours");
+
+            GridRegion rinfo = m_GridService.GetRegionByUUID(scopeID, regionID);
+            //m_log.DebugFormat("[GRID HANDLER]: neighbours for region {0}: {1}", regionID, rinfos.Count);
+
+            Dictionary<string, object> result = new Dictionary<string, object>();
+            if (rinfo == null)
+                result["result"] = "null";
+            else
+                result["result"] = rinfo.ToKeyValuePairs();
+
+            string xmlString = ServerUtils.BuildXmlResponse(result);
+            //m_log.DebugFormat("[GRID HANDLER]: resp string: {0}", xmlString);
+            UTF8Encoding encoding = new UTF8Encoding();
+            return encoding.GetBytes(xmlString);
+        }
+
+        byte[] GetRegionByPosition(Dictionary<string, string> request)
+        {
+            UUID scopeID = UUID.Zero;
+            if (request["SCOPEID"] != null)
+                UUID.TryParse(request["SCOPEID"], out scopeID);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no scopeID in request to get region by position");
+
+            int x = 0, y = 0;
+            if (request["X"] != null)
+                Int32.TryParse(request["X"], out x);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no X in request to get region by position");
+            if (request["Y"] != null)
+                Int32.TryParse(request["Y"], out y);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no Y in request to get region by position");
+
+            GridRegion rinfo = m_GridService.GetRegionByPosition(scopeID, x, y);
+            //m_log.DebugFormat("[GRID HANDLER]: neighbours for region {0}: {1}", regionID, rinfos.Count);
+
+            Dictionary<string, object> result = new Dictionary<string, object>();
+            if (rinfo == null)
+                result["result"] = "null";
+            else
+                result["result"] = rinfo.ToKeyValuePairs();
+
+            string xmlString = ServerUtils.BuildXmlResponse(result);
+            //m_log.DebugFormat("[GRID HANDLER]: resp string: {0}", xmlString);
+            UTF8Encoding encoding = new UTF8Encoding();
+            return encoding.GetBytes(xmlString);
+        }
+
+        byte[] GetRegionByName(Dictionary<string, string> request)
+        {
+            UUID scopeID = UUID.Zero;
+            if (request["SCOPEID"] != null)
+                UUID.TryParse(request["SCOPEID"], out scopeID);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no scopeID in request to get region by name");
+
+            string regionName = string.Empty;
+            if (request["NAME"] != null)
+                regionName = request["NAME"];
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no name in request to get region by name");
+
+            GridRegion rinfo = m_GridService.GetRegionByName(scopeID, regionName);
+            //m_log.DebugFormat("[GRID HANDLER]: neighbours for region {0}: {1}", regionID, rinfos.Count);
+
+            Dictionary<string, object> result = new Dictionary<string, object>();
+            if (rinfo == null)
+                result["result"] = "null";
+            else
+                result["result"] = rinfo.ToKeyValuePairs();
+
+            string xmlString = ServerUtils.BuildXmlResponse(result);
+            //m_log.DebugFormat("[GRID HANDLER]: resp string: {0}", xmlString);
+            UTF8Encoding encoding = new UTF8Encoding();
+            return encoding.GetBytes(xmlString);
+        }
+
+        byte[] GetRegionsByName(Dictionary<string, string> request)
+        {
+            UUID scopeID = UUID.Zero;
+            if (request["SCOPEID"] != null)
+                UUID.TryParse(request["SCOPEID"], out scopeID);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no scopeID in request to get regions by name");
+
+            string regionName = string.Empty;
+            if (request["NAME"] != null)
+                regionName = request["NAME"];
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no NAME in request to get regions by name");
+
+            int max = 0;
+            if (request["MAX"] != null)
+                Int32.TryParse(request["MAX"], out max);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no MAX in request to get regions by name");
+
+            List<GridRegion> rinfos = m_GridService.GetRegionsByName(scopeID, regionName, max);
+            //m_log.DebugFormat("[GRID HANDLER]: neighbours for region {0}: {1}", regionID, rinfos.Count);
+
+            Dictionary<string, object> result = new Dictionary<string, object>();
+            if ((rinfos == null) || ((rinfos != null) && (rinfos.Count == 0)))
+                result["result"] = "null";
+            else
+            {
+                int i = 0;
+                foreach (GridRegion rinfo in rinfos)
+                {
+                    Dictionary<string, object> rinfoDict = rinfo.ToKeyValuePairs();
+                    result["region" + i] = rinfoDict;
+                    i++;
+                }
+            }
+
+            string xmlString = ServerUtils.BuildXmlResponse(result);
+            //m_log.DebugFormat("[GRID HANDLER]: resp string: {0}", xmlString);
+            UTF8Encoding encoding = new UTF8Encoding();
+            return encoding.GetBytes(xmlString);
+        }
+
+        byte[] GetRegionRange(Dictionary<string, string> request)
+        {
+            //m_log.DebugFormat("[GRID HANDLER]: GetRegionRange");
+            UUID scopeID = UUID.Zero;
+            if (request.ContainsKey("SCOPEID"))
+                UUID.TryParse(request["SCOPEID"], out scopeID);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no scopeID in request to get region range");
+
+            int xmin = 0, xmax = 0, ymin = 0, ymax = 0;
+            if (request.ContainsKey("XMIN"))
+                Int32.TryParse(request["XMIN"], out xmin);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no XMIN in request to get region range");
+            if (request.ContainsKey("XMAX"))
+                Int32.TryParse(request["XMAX"], out xmax);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no XMAX in request to get region range");
+            if (request.ContainsKey("YMIN"))
+                Int32.TryParse(request["YMIN"], out ymin);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no YMIN in request to get region range");
+            if (request.ContainsKey("YMAX"))
+                Int32.TryParse(request["YMAX"], out ymax);
+            else
+                m_log.WarnFormat("[GRID HANDLER]: no YMAX in request to get region range");
+
+
+            List<GridRegion> rinfos = m_GridService.GetRegionRange(scopeID, xmin, xmax, ymin, ymax);
+
+            Dictionary<string, object> result = new Dictionary<string, object>();
+            if ((rinfos == null) || ((rinfos != null) && (rinfos.Count == 0)))
+                result["result"] = "null";
+            else
+            {
+                int i = 0;
+                foreach (GridRegion rinfo in rinfos)
+                {
+                    Dictionary<string, object> rinfoDict = rinfo.ToKeyValuePairs();
+                    result["region" + i] = rinfoDict;
+                    i++;
+                }
+            }
+            string xmlString = ServerUtils.BuildXmlResponse(result);
+            //m_log.DebugFormat("[GRID HANDLER]: resp string: {0}", xmlString);
+            UTF8Encoding encoding = new UTF8Encoding();
+            return encoding.GetBytes(xmlString);
+        }
+
+        #endregion
+
+        #region Misc
+
+        private byte[] SuccessResult()
+        {
+            XmlDocument doc = new XmlDocument();
+
+            XmlNode xmlnode = doc.CreateNode(XmlNodeType.XmlDeclaration,
+                    "", "");
+
+            doc.AppendChild(xmlnode);
+
+            XmlElement rootElement = doc.CreateElement("", "ServerResponse",
+                    "");
+
+            doc.AppendChild(rootElement);
+
+            XmlElement result = doc.CreateElement("", "Result", "");
+            result.AppendChild(doc.CreateTextNode("Success"));
+
+            rootElement.AppendChild(result);
+
+            return DocToBytes(doc);
+        }
+
+        private byte[] FailureResult()
+        {
+            XmlDocument doc = new XmlDocument();
+
+            XmlNode xmlnode = doc.CreateNode(XmlNodeType.XmlDeclaration,
+                    "", "");
+
+            doc.AppendChild(xmlnode);
+
+            XmlElement rootElement = doc.CreateElement("", "ServerResponse",
+                    "");
+
+            doc.AppendChild(rootElement);
+
+            XmlElement result = doc.CreateElement("", "Result", "");
+            result.AppendChild(doc.CreateTextNode("Failure"));
+
+            rootElement.AppendChild(result);
+
+            return DocToBytes(doc);
+        }
+
+        private byte[] DocToBytes(XmlDocument doc)
+        {
+            MemoryStream ms = new MemoryStream();
+            XmlTextWriter xw = new XmlTextWriter(ms, null);
+            xw.Formatting = Formatting.Indented;
+            doc.WriteTo(xw);
+            xw.Flush();
+
+            return ms.ToArray();
+        }
+
+        #endregion
+    }
+}
diff --git a/OpenSim/Server/Handlers/Grid/HypergridServerConnector.cs b/OpenSim/Server/Handlers/Grid/HypergridServerConnector.cs
new file mode 100644
index 0000000..115ac29
--- /dev/null
+++ b/OpenSim/Server/Handlers/Grid/HypergridServerConnector.cs
@@ -0,0 +1,208 @@
+/*
+ * 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.Reflection;
+using System.Net;
+using Nini.Config;
+using OpenSim.Framework;
+using OpenSim.Server.Base;
+using OpenSim.Services.Interfaces;
+using OpenSim.Framework.Servers.HttpServer;
+using OpenSim.Server.Handlers.Base;
+using GridRegion = OpenSim.Services.Interfaces.GridRegion;
+
+using OpenMetaverse;
+using log4net;
+using Nwc.XmlRpc;
+
+namespace OpenSim.Server.Handlers.Grid
+{
+    public class HypergridServiceInConnector : ServiceConnector
+    {
+        private static readonly ILog m_log =
+                LogManager.GetLogger(
+                MethodBase.GetCurrentMethod().DeclaringType);
+
+        private List<GridRegion> m_RegionsOnSim = new List<GridRegion>();
+        private IHyperlinkService m_HyperlinkService;
+
+        public HypergridServiceInConnector(IConfigSource config, IHttpServer server, IHyperlinkService hyperService) :
+                base(config, server, String.Empty)
+        {
+            m_HyperlinkService = hyperService;
+            server.AddXmlRPCHandler("link_region", LinkRegionRequest, false);
+            server.AddXmlRPCHandler("expect_hg_user", ExpectHGUser, false);
+        }
+
+        public void AddRegion(GridRegion rinfo)
+        {
+            m_RegionsOnSim.Add(rinfo);
+        }
+
+        public void RemoveRegion(GridRegion rinfo)
+        {
+            if (m_RegionsOnSim.Contains(rinfo))
+                m_RegionsOnSim.Remove(rinfo);
+        }
+
+        /// <summary>
+        /// Someone wants to link to us
+        /// </summary>
+        /// <param name="request"></param>
+        /// <returns></returns>
+        public XmlRpcResponse LinkRegionRequest(XmlRpcRequest request, IPEndPoint remoteClient)
+        {
+            Hashtable requestData = (Hashtable)request.Params[0];
+            //string host = (string)requestData["host"];
+            //string portstr = (string)requestData["port"];
+            string name = (string)requestData["region_name"];
+
+            m_log.DebugFormat("[HGrid]: Hyperlink request");
+
+            GridRegion regInfo = null;
+            foreach (GridRegion r in m_RegionsOnSim)
+            {
+                if ((r.RegionName != null) && (name != null) && (r.RegionName.ToLower() == name.ToLower()))
+                {
+                    regInfo = r;
+                    break;
+                }
+            }
+
+            if (regInfo == null)
+                regInfo = m_RegionsOnSim[0]; // Send out the first region
+
+            Hashtable hash = new Hashtable();
+            hash["uuid"] = regInfo.RegionID.ToString();
+            m_log.Debug(">> Here " + regInfo.RegionID);
+            hash["handle"] = regInfo.RegionHandle.ToString();
+            hash["region_image"] = regInfo.TerrainImage.ToString();
+            hash["region_name"] = regInfo.RegionName;
+            hash["internal_port"] = regInfo.InternalEndPoint.Port.ToString();
+            //m_log.Debug(">> Here: " + regInfo.InternalEndPoint.Port);
+
+
+            XmlRpcResponse response = new XmlRpcResponse();
+            response.Value = hash;
+            return response;
+        }
+
+        /// <summary>
+        /// Received from other HGrid nodes when a user wants to teleport here.  This call allows
+        /// the region to prepare for direct communication from the client.  Sends back an empty
+        /// xmlrpc response on completion.
+        /// This is somewhat similar to OGS1's ExpectUser, but with the additional task of
+        /// registering the user in the local user cache.
+        /// </summary>
+        /// <param name="request"></param>
+        /// <returns></returns>
+        public XmlRpcResponse ExpectHGUser(XmlRpcRequest request, IPEndPoint remoteClient)
+        {
+            Hashtable requestData = (Hashtable)request.Params[0];
+            ForeignUserProfileData userData = new ForeignUserProfileData();
+
+            userData.FirstName = (string)requestData["firstname"];
+            userData.SurName = (string)requestData["lastname"];
+            userData.ID = new UUID((string)requestData["agent_id"]);
+            UUID sessionID = new UUID((string)requestData["session_id"]);
+            userData.HomeLocation = new Vector3((float)Convert.ToDecimal((string)requestData["startpos_x"]),
+                                  (float)Convert.ToDecimal((string)requestData["startpos_y"]),
+                                  (float)Convert.ToDecimal((string)requestData["startpos_z"]));
+
+            userData.UserServerURI = (string)requestData["userserver_id"];
+            userData.UserAssetURI = (string)requestData["assetserver_id"];
+            userData.UserInventoryURI = (string)requestData["inventoryserver_id"];
+
+            m_log.DebugFormat("[HGrid]: Prepare for connection from {0} {1} (@{2}) UUID={3}",
+                              userData.FirstName, userData.SurName, userData.UserServerURI, userData.ID);
+
+            ulong userRegionHandle = 0;
+            int userhomeinternalport = 0;
+            if (requestData.ContainsKey("region_uuid"))
+            {
+                UUID uuid = UUID.Zero;
+                UUID.TryParse((string)requestData["region_uuid"], out uuid);
+                userData.HomeRegionID = uuid;
+                userRegionHandle = Convert.ToUInt64((string)requestData["regionhandle"]);
+                userData.UserHomeAddress = (string)requestData["home_address"];
+                userData.UserHomePort = (string)requestData["home_port"];
+                userhomeinternalport = Convert.ToInt32((string)requestData["internal_port"]);
+
+                m_log.Debug("[HGrid]: home_address: " + userData.UserHomeAddress +
+                           "; home_port: " + userData.UserHomePort);
+            }
+            else
+                m_log.WarnFormat("[HGrid]: User has no home region information");
+
+            XmlRpcResponse resp = new XmlRpcResponse();
+
+            // Let's check if someone is trying to get in with a stolen local identity.
+            // The need for this test is a consequence of not having truly global names :-/
+            bool comingHome = false;
+            if (m_HyperlinkService.CheckUserAtEntry(userData.ID, sessionID, out comingHome) == false)
+            {
+                m_log.WarnFormat("[HGrid]: Access denied to foreign user.");
+                Hashtable respdata = new Hashtable();
+                respdata["success"] = "FALSE";
+                respdata["reason"] = "Foreign user has the same ID as a local user, or logins disabled.";
+                resp.Value = respdata;
+                return resp;
+            }
+
+            // Finally, everything looks ok
+            //m_log.Debug("XXX---- EVERYTHING OK ---XXX");
+
+            if (!comingHome)
+            {
+                // We don't do this if the user is coming to the home grid
+                GridRegion home = new GridRegion();
+                home.RegionID = userData.HomeRegionID;
+                home.ExternalHostName = userData.UserHomeAddress;
+                home.HttpPort = Convert.ToUInt32(userData.UserHomePort);
+                uint x = 0, y = 0;
+                Utils.LongToUInts(userRegionHandle, out x, out y);
+                home.RegionLocX = (int)x;
+                home.RegionLocY = (int)y;
+                home.InternalEndPoint = new IPEndPoint(IPAddress.Parse("0.0.0.0"), (int)userhomeinternalport);
+
+                m_HyperlinkService.AcceptUser(userData, home);
+            }
+            // else the user is coming to a non-home region of the home grid
+            // We simply drop this user information altogether
+ 
+            Hashtable respdata2 = new Hashtable();
+            respdata2["success"] = "TRUE";
+            resp.Value = respdata2;
+
+            return resp;
+        }
+
+    }
+}