this is step 2 of 2 of the OpenSim.Region.Environment refactor.

NOTHING has been deleted or moved off to forge at this point.  what
has happened is that OpenSim.Region.Environment.Modules has been split
in two:

- OpenSim.Region.CoreModules: all those modules that are either
  directly or indirectly referenced from  other  OpenSim packages, or
  that provide functionality that the OpenSim developer community
  considers core functionality:

      CoreModules/Agent/AssetTransaction
      CoreModules/Agent/Capabilities
      CoreModules/Agent/TextureDownload
      CoreModules/Agent/TextureSender
      CoreModules/Agent/TextureSender/Tests
      CoreModules/Agent/Xfer
      CoreModules/Avatar/AvatarFactory
      CoreModules/Avatar/Chat/ChatModule
      CoreModules/Avatar/Combat
      CoreModules/Avatar/Currency/SampleMoney
      CoreModules/Avatar/Dialog
      CoreModules/Avatar/Friends
      CoreModules/Avatar/Gestures
      CoreModules/Avatar/Groups
      CoreModules/Avatar/InstantMessage
      CoreModules/Avatar/Inventory
      CoreModules/Avatar/Inventory/Archiver
      CoreModules/Avatar/Inventory/Transfer
      CoreModules/Avatar/Lure
      CoreModules/Avatar/ObjectCaps
      CoreModules/Avatar/Profiles
      CoreModules/Communications/Local
      CoreModules/Communications/REST
      CoreModules/Framework/EventQueue
      CoreModules/Framework/InterfaceCommander
      CoreModules/Hypergrid
      CoreModules/InterGrid
      CoreModules/Scripting/DynamicTexture
      CoreModules/Scripting/EMailModules
      CoreModules/Scripting/HttpRequest
      CoreModules/Scripting/LoadImageURL
      CoreModules/Scripting/VectorRender
      CoreModules/Scripting/WorldComm
      CoreModules/Scripting/XMLRPC
      CoreModules/World/Archiver
      CoreModules/World/Archiver/Tests
      CoreModules/World/Estate
      CoreModules/World/Land
      CoreModules/World/Permissions
      CoreModules/World/Serialiser
      CoreModules/World/Sound
      CoreModules/World/Sun
      CoreModules/World/Terrain
      CoreModules/World/Terrain/DefaultEffects
      CoreModules/World/Terrain/DefaultEffects/bin
      CoreModules/World/Terrain/DefaultEffects/bin/Debug
      CoreModules/World/Terrain/Effects
      CoreModules/World/Terrain/FileLoaders
      CoreModules/World/Terrain/FloodBrushes
      CoreModules/World/Terrain/PaintBrushes
      CoreModules/World/Terrain/Tests
      CoreModules/World/Vegetation
      CoreModules/World/Wind
      CoreModules/World/WorldMap

- OpenSim.Region.OptionalModules: all those modules that are not core
  modules:

      OptionalModules/Avatar/Chat/IRC-stuff
      OptionalModules/Avatar/Concierge
      OptionalModules/Avatar/Voice/AsterixVoice
      OptionalModules/Avatar/Voice/SIPVoice
      OptionalModules/ContentManagementSystem
      OptionalModules/Grid/Interregion
      OptionalModules/Python
      OptionalModules/SvnSerialiser
      OptionalModules/World/NPC
      OptionalModules/World/TreePopulator

2 files changed, 1204 insertions, 0 deletions

diff --git a/OpenSim/Region/CoreModules/Communications/Local/LocalInterregionComms.cs b/OpenSim/Region/CoreModules/Communications/Local/LocalInterregionComms.cs
new file mode 100644
index 0000000..3a9df4a
--- /dev/null
+++ b/OpenSim/Region/CoreModules/Communications/Local/LocalInterregionComms.cs
@@ -0,0 +1,244 @@
+/*
+ * 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 OpenSim 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.Net.Sockets;
+using System.Reflection;
+using System.Threading;
+using System.Xml;
+using OpenMetaverse;
+using log4net;
+using Nini.Config;
+using Nwc.XmlRpc;
+using OpenSim.Framework;
+using OpenSim.Framework.Communications.Cache;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Region.Framework.Scenes;
+
+namespace OpenSim.Region.CoreModules.Communications.Local
+{
+    public class LocalInterregionComms : IRegionModule, IInterregionCommsOut, IInterregionCommsIn
+    {
+        private bool m_enabled = false;
+
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+        private List<Scene> m_sceneList = new List<Scene>();
+
+        #region Events
+        public event ChildAgentUpdateReceived OnChildAgentUpdate;
+
+        #endregion /* Events */
+
+        #region IRegionModule
+
+        public void Initialise(Scene scene, IConfigSource config)
+        {
+            if (m_sceneList.Count == 0)
+            {
+                IConfig startupConfig = config.Configs["Communications"];
+
+                if ((startupConfig != null) && (startupConfig.GetString("InterregionComms", "RESTCommms") == "LocalComms"))
+                {
+                    m_log.Debug("[LOCAL COMMS]: Enabling InterregionComms LocalComms module");
+                    m_enabled = true;
+                }
+            }
+
+            if (!m_enabled)
+                return;
+
+            Init(scene);
+        }
+
+        public void PostInitialise()
+        {
+        }
+
+        public void Close()
+        {
+        }
+
+        public string Name
+        {
+            get { return "LocalInterregionCommsModule"; }
+        }
+
+        public bool IsSharedModule
+        {
+            get { return true; }
+        }
+        /// <summary>
+        /// Can be called from other modules.
+        /// </summary>
+        /// <param name="scene"></param>
+        public void Init(Scene scene)
+        {
+            if (!m_sceneList.Contains(scene))
+            {
+                lock (m_sceneList)
+                {
+                    m_sceneList.Add(scene);
+                    if (m_enabled)
+                        scene.RegisterModuleInterface<IInterregionCommsOut>(this);
+                    scene.RegisterModuleInterface<IInterregionCommsIn>(this);
+                }
+
+            }
+        }
+
+        #endregion /* IRegionModule */
+
+        #region IInterregionComms
+
+        /**
+         * Agent-related communications 
+         */
+
+        public bool SendCreateChildAgent(ulong regionHandle, AgentCircuitData aCircuit)
+        {            
+            foreach (Scene s in m_sceneList)
+            {                
+                if (s.RegionInfo.RegionHandle == regionHandle)
+                {
+//                    m_log.DebugFormat("[LOCAL COMMS]: Found region {0} to send SendCreateChildAgent", regionHandle);
+                    s.NewUserConnection(aCircuit);
+                    return true;
+                }
+            }
+            
+//            m_log.DebugFormat("[LOCAL COMMS]: Did not find region {0} for SendCreateChildAgent", regionHandle);
+            return false;
+        }
+
+        public bool SendChildAgentUpdate(ulong regionHandle, AgentData cAgentData)
+        {
+            foreach (Scene s in m_sceneList)
+            {
+                if (s.RegionInfo.RegionHandle == regionHandle)
+                {
+                    //m_log.DebugFormat(
+                    //    "[LOCAL COMMS]: Found region {0} {1} to send ChildAgentUpdate", 
+                    //    s.RegionInfo.RegionName, regionHandle);
+                    
+                    s.IncomingChildAgentDataUpdate(cAgentData);
+                    return true;
+                }
+            }
+            
+//            m_log.DebugFormat("[LOCAL COMMS]: Did not find region {0} for ChildAgentUpdate", regionHandle);
+            return false;
+        }
+
+        public bool SendChildAgentUpdate(ulong regionHandle, AgentPosition cAgentData)
+        {
+            foreach (Scene s in m_sceneList)
+            {
+                if (s.RegionInfo.RegionHandle == regionHandle)
+                {
+                    //m_log.Debug("[LOCAL COMMS]: Found region to send ChildAgentUpdate");
+                    s.IncomingChildAgentDataUpdate(cAgentData);
+                    return true;
+                }
+            }
+            //m_log.Debug("[LOCAL COMMS]: region not found for ChildAgentUpdate");
+            return false;
+        }
+
+        public bool SendReleaseAgent(ulong regionHandle, UUID id, string uri)
+        {
+            //uint x, y;
+            //Utils.LongToUInts(regionHandle, out x, out y);
+            //x = x / Constants.RegionSize;
+            //y = y / Constants.RegionSize;
+            //Console.WriteLine("\n >>> Local SendReleaseAgent " + x + "-" + y);
+            foreach (Scene s in m_sceneList)
+            {
+                if (s.RegionInfo.RegionHandle == regionHandle)
+                {
+                    //m_log.Debug("[LOCAL COMMS]: Found region to SendReleaseAgent");
+                    return s.IncomingReleaseAgent(id);
+                }
+            }
+            //m_log.Debug("[LOCAL COMMS]: region not found in SendReleaseAgent");
+            return false;
+        }
+
+        public bool SendCloseAgent(ulong regionHandle, UUID id)
+        {
+            //uint x, y;
+            //Utils.LongToUInts(regionHandle, out x, out y);
+            //x = x / Constants.RegionSize;
+            //y = y / Constants.RegionSize;
+            //Console.WriteLine("\n >>> Local SendCloseAgent " + x + "-" + y);
+            foreach (Scene s in m_sceneList)
+            {
+                if (s.RegionInfo.RegionHandle == regionHandle)
+                {
+                    //m_log.Debug("[LOCAL COMMS]: Found region to SendCloseAgent");
+                    return s.IncomingCloseAgent(id);
+                }
+            }
+            //m_log.Debug("[LOCAL COMMS]: region not found in SendCloseAgent");
+            return false;
+        }
+
+        /**
+         * Object-related communications 
+         */
+
+        public bool SendCreateObject(ulong regionHandle, ISceneObject sog)
+        {
+            foreach (Scene s in m_sceneList)
+            {
+                if (s.RegionInfo.RegionHandle == regionHandle)
+                {
+                    //m_log.Debug("[LOCAL COMMS]: Found region to SendCreateObject");
+                    return s.IncomingCreateObject(sog);
+                }
+            }
+            return false;
+        }
+
+        #endregion /* IInterregionComms */
+
+        #region Misc
+
+        public UUID GetRegionID(ulong regionhandle)
+        {
+            foreach (Scene s in m_sceneList)
+            {
+                if (s.RegionInfo.RegionHandle == regionhandle)
+                    return s.RegionInfo.RegionID;
+            }
+            // ? weird. should not happen
+            return m_sceneList[0].RegionInfo.RegionID;
+        }
+        #endregion
+    }
+}
diff --git a/OpenSim/Region/CoreModules/Communications/REST/RESTInterregionComms.cs b/OpenSim/Region/CoreModules/Communications/REST/RESTInterregionComms.cs
new file mode 100644
index 0000000..b4f4814
--- /dev/null
+++ b/OpenSim/Region/CoreModules/Communications/REST/RESTInterregionComms.cs
@@ -0,0 +1,960 @@
+/*
+ * 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 OpenSim 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.IO;
+using System.Net;
+using System.Net.Sockets;
+using System.Reflection;
+using System.Threading;
+using System.Xml;
+using OpenMetaverse;
+using OpenMetaverse.StructuredData;
+using log4net;
+using Nini.Config;
+using Nwc.XmlRpc;
+using OpenSim.Framework;
+using OpenSim.Framework.Communications;
+using OpenSim.Framework.Communications.Cache;
+using OpenSim.Framework.Servers;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Region.Framework.Scenes;
+using OpenSim.Region.Framework.Scenes.Hypergrid;
+using OpenSim.Region.CoreModules.Communications.Local;
+
+namespace OpenSim.Region.CoreModules.Communications.REST
+{
+    public class RESTInterregionComms : IRegionModule, IInterregionCommsOut
+    {
+        private static bool initialized = false;
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
+        protected bool m_enabled = false;
+        protected Scene m_aScene;
+        // RESTInterregionComms does not care about local regions; it delegates that to the Local module
+        protected LocalInterregionComms m_localBackend;
+
+        protected CommunicationsManager m_commsManager;
+
+        #region IRegionModule
+
+        public virtual void Initialise(Scene scene, IConfigSource config)
+        {
+            if (!initialized)
+            {
+                initialized = true;
+                IConfig startupConfig = config.Configs["Communications"];
+                
+                if ((startupConfig == null) 
+                    || (startupConfig != null) 
+                    && (startupConfig.GetString("InterregionComms", "RESTComms") == "RESTComms"))
+                {
+                    m_log.Info("[REST COMMS]: Enabling InterregionComms RESTComms module");
+                    m_enabled = true;
+                    InitOnce(scene);
+                }
+            }
+
+            if (!m_enabled)
+                return;
+
+            InitEach(scene);
+
+        }
+
+        public virtual void PostInitialise()
+        {
+            if (m_enabled)
+                AddHTTPHandlers();
+        }
+
+        public virtual void Close()
+        {
+        }
+
+        public virtual string Name
+        {
+            get { return "RESTInterregionCommsModule"; }
+        }
+
+        public virtual bool IsSharedModule
+        {
+            get { return true; }
+        }
+
+        protected virtual void InitEach(Scene scene)
+        {
+            m_localBackend.Init(scene);
+            scene.RegisterModuleInterface<IInterregionCommsOut>(this);
+        }
+
+        protected virtual void InitOnce(Scene scene)
+        {
+            m_localBackend = new LocalInterregionComms();
+            m_commsManager = scene.CommsManager;
+            m_aScene = scene;
+        }
+
+        protected virtual void AddHTTPHandlers()
+        {
+            m_aScene.CommsManager.HttpServer.AddHTTPHandler("/agent/", AgentHandler);
+            m_aScene.CommsManager.HttpServer.AddHTTPHandler("/object/", ObjectHandler);
+        }
+
+        #endregion /* IRegionModule */
+
+        #region IInterregionComms
+
+        /**
+         * Agent-related communications 
+         */
+
+        public bool SendCreateChildAgent(ulong regionHandle, AgentCircuitData aCircuit)
+        {
+            // Try local first
+            if (m_localBackend.SendCreateChildAgent(regionHandle, aCircuit))
+                return true;
+
+            // else do the remote thing
+            RegionInfo regInfo = m_commsManager.GridService.RequestNeighbourInfo(regionHandle);
+            if (regInfo != null)
+            {
+                SendUserInformation(regInfo, aCircuit);
+
+                return DoCreateChildAgentCall(regInfo, aCircuit);
+            }
+            //else
+            //    m_log.Warn("[REST COMMS]: Region not found " + regionHandle);
+            return false;
+        }
+
+        public bool SendChildAgentUpdate(ulong regionHandle, AgentData cAgentData)
+        {
+            // Try local first
+            if (m_localBackend.SendChildAgentUpdate(regionHandle, cAgentData))
+                return true;
+
+            // else do the remote thing
+            RegionInfo regInfo = m_commsManager.GridService.RequestNeighbourInfo(regionHandle);
+            if (regInfo != null)
+            {
+                return DoChildAgentUpdateCall(regInfo, cAgentData);
+            }
+            //else
+            //    m_log.Warn("[REST COMMS]: Region not found " + regionHandle);
+            return false;
+
+        }
+
+        public bool SendChildAgentUpdate(ulong regionHandle, AgentPosition cAgentData)
+        {
+            // Try local first
+            if (m_localBackend.SendChildAgentUpdate(regionHandle, cAgentData))
+                return true;
+
+            // else do the remote thing
+            RegionInfo regInfo = m_commsManager.GridService.RequestNeighbourInfo(regionHandle);
+            if (regInfo != null)
+            {
+                return DoChildAgentUpdateCall(regInfo, cAgentData);
+            }
+            //else
+            //    m_log.Warn("[REST COMMS]: Region not found " + regionHandle);
+            return false;
+
+        }
+        
+        public bool SendReleaseAgent(ulong regionHandle, UUID id, string uri)
+        {
+            // Try local first
+            if (m_localBackend.SendReleaseAgent(regionHandle, id, uri))
+                return true;
+
+            // else do the remote thing
+            return DoReleaseAgentCall(regionHandle, id, uri);
+        }
+
+        public bool SendCloseAgent(ulong regionHandle, UUID id)
+        {
+            // Try local first
+            if (m_localBackend.SendCloseAgent(regionHandle, id))
+                return true;
+
+            // else do the remote thing
+            RegionInfo regInfo = m_commsManager.GridService.RequestNeighbourInfo(regionHandle);
+            if (regInfo != null)
+            {
+                return DoCloseAgentCall(regInfo, id);
+            }
+            //else
+            //    m_log.Warn("[REST COMMS]: Region not found " + regionHandle);
+            return false;
+        }
+
+        /**
+         * Object-related communications 
+         */
+
+        public bool SendCreateObject(ulong regionHandle, ISceneObject sog)
+        {
+            // Try local first
+            ISceneObject sogClone = sog.CloneForNewScene();
+            if (m_localBackend.SendCreateObject(regionHandle, sogClone))
+            {
+                //m_log.Debug("[REST COMMS]: LocalBackEnd SendCreateObject succeeded");
+                return true;
+            }
+
+            // else do the remote thing
+            RegionInfo regInfo = m_commsManager.GridService.RequestNeighbourInfo(regionHandle);
+            if (regInfo != null)
+            {
+                return DoCreateObjectCall(regInfo, sog);
+            }
+            //else
+            //    m_log.Warn("[REST COMMS]: Region not found " + regionHandle);
+            return false;
+        }
+
+        #endregion /* IInterregionComms */
+
+        #region DoWork functions for the above public interface
+        
+        //-------------------------------------------------------------------
+        // Internal  functions for the above public interface
+        //-------------------------------------------------------------------
+
+        protected bool DoCreateChildAgentCall(RegionInfo region, AgentCircuitData aCircuit)
+        {
+            // Eventually, we want to use a caps url instead of the agentID
+            string uri = "http://" + region.ExternalEndPoint.Address + ":" + region.HttpPort + "/agent/" + aCircuit.AgentID + "/";
+            //Console.WriteLine("   >>> DoCreateChildAgentCall <<< " + uri);
+
+            WebRequest AgentCreateRequest = WebRequest.Create(uri);
+            AgentCreateRequest.Method = "POST";
+            AgentCreateRequest.ContentType = "application/json";
+            AgentCreateRequest.Timeout = 10000;
+
+            // Fill it in
+            OSDMap args = null;
+            try
+            {
+                args = aCircuit.PackAgentCircuitData();
+            }
+            catch (Exception e)
+            {
+                m_log.Debug("[REST COMMS]: PackAgentCircuitData failed with exception: " + e.Message);
+            }
+            // Add the regionhandle of the destination region
+            ulong regionHandle = GetRegionHandle(region.RegionHandle);
+            args["destination_handle"] = OSD.FromString(regionHandle.ToString());
+
+            string strBuffer = "";
+            byte[] buffer = new byte[1];
+            try
+            {
+                strBuffer = OSDParser.SerializeJsonString(args);
+                System.Text.UTF8Encoding str = new System.Text.UTF8Encoding();
+                buffer = str.GetBytes(strBuffer);
+
+            }
+            catch (Exception e)
+            {
+                m_log.WarnFormat("[OSG2]: Exception thrown on serialization of ChildCreate: {0}", e.Message);
+                // ignore. buffer will be empty, caller should check.
+            }
+
+            Stream os = null;
+            try
+            { // send the Post
+                AgentCreateRequest.ContentLength = buffer.Length;   //Count bytes to send
+                os = AgentCreateRequest.GetRequestStream();
+                os.Write(buffer, 0, strBuffer.Length);         //Send it
+                os.Close();
+                //m_log.InfoFormat("[REST COMMS]: Posted ChildAgentUpdate request to remote sim {0}", uri);
+            }
+            //catch (WebException ex)
+            catch
+            {
+                //m_log.InfoFormat("[REST COMMS]: Bad send on ChildAgentUpdate {0}", ex.Message);
+
+                return false;
+            }
+
+            // Let's wait for the response
+            //m_log.Info("[REST COMMS]: Waiting for a reply after DoCreateChildAgentCall");
+
+            try
+            {
+                WebResponse webResponse = AgentCreateRequest.GetResponse();
+                if (webResponse == null)
+                {
+                    m_log.Info("[REST COMMS]: Null reply on DoCreateChildAgentCall post");
+                }
+
+                StreamReader sr = new StreamReader(webResponse.GetResponseStream());
+                //reply = sr.ReadToEnd().Trim();
+                sr.ReadToEnd().Trim();
+                sr.Close();
+                //m_log.InfoFormat("[REST COMMS]: DoCreateChildAgentCall reply was {0} ", reply);
+
+            }
+            catch (WebException ex)
+            {
+                m_log.InfoFormat("[REST COMMS]: exception on reply of DoCreateChildAgentCall {0}", ex.Message);
+                // ignore, really
+            }
+
+            return true;
+
+        }
+
+        protected bool DoChildAgentUpdateCall(RegionInfo region, IAgentData cAgentData)
+        {
+            // Eventually, we want to use a caps url instead of the agentID
+            string uri = "http://" + region.ExternalEndPoint.Address + ":" + region.HttpPort + "/agent/" + cAgentData.AgentID + "/";
+            //Console.WriteLine("   >>> DoChildAgentUpdateCall <<< " + uri);
+
+            WebRequest ChildUpdateRequest = WebRequest.Create(uri);
+            ChildUpdateRequest.Method = "PUT";
+            ChildUpdateRequest.ContentType = "application/json";
+            ChildUpdateRequest.Timeout = 10000;
+
+            // Fill it in
+            OSDMap args = null;
+            try
+            {
+                args = cAgentData.PackUpdateMessage();
+            }
+            catch (Exception e)
+            {
+                m_log.Debug("[REST COMMS]: PackUpdateMessage failed with exception: " + e.Message);
+            }
+            // Add the regionhandle of the destination region
+            ulong regionHandle = GetRegionHandle(region.RegionHandle);
+            args["destination_handle"] = OSD.FromString(regionHandle.ToString());
+
+            string strBuffer = "";
+            byte[] buffer = new byte[1];
+            try
+            {
+                strBuffer = OSDParser.SerializeJsonString(args);
+                System.Text.UTF8Encoding str = new System.Text.UTF8Encoding();
+                buffer = str.GetBytes(strBuffer);
+
+            }
+            catch (Exception e)
+            {
+                m_log.WarnFormat("[REST COMMS]: Exception thrown on serialization of ChildUpdate: {0}", e.Message);
+                // ignore. buffer will be empty, caller should check.
+            }
+
+            Stream os = null;
+            try
+            { // send the Post
+                ChildUpdateRequest.ContentLength = buffer.Length;   //Count bytes to send
+                os = ChildUpdateRequest.GetRequestStream();
+                os.Write(buffer, 0, strBuffer.Length);         //Send it
+                os.Close();
+                //m_log.InfoFormat("[REST COMMS]: Posted ChildAgentUpdate request to remote sim {0}", uri);
+            }
+            //catch (WebException ex)
+            catch                
+            {
+                //m_log.InfoFormat("[REST COMMS]: Bad send on ChildAgentUpdate {0}", ex.Message);
+
+                return false;
+            }
+
+            // Let's wait for the response
+            //m_log.Info("[REST COMMS]: Waiting for a reply after ChildAgentUpdate");
+            
+            try
+            {
+                WebResponse webResponse = ChildUpdateRequest.GetResponse();
+                if (webResponse == null)
+                {
+                    m_log.Info("[REST COMMS]: Null reply on ChilAgentUpdate post");
+                }
+
+                StreamReader sr = new StreamReader(webResponse.GetResponseStream());
+                //reply = sr.ReadToEnd().Trim();
+                sr.ReadToEnd().Trim();
+                sr.Close();
+                //m_log.InfoFormat("[REST COMMS]: ChilAgentUpdate reply was {0} ", reply);
+
+            }
+            catch (WebException ex)
+            {
+                m_log.InfoFormat("[REST COMMS]: exception on reply of ChilAgentUpdate {0}", ex.Message);
+                // ignore, really
+            }
+
+            return true;
+        }
+
+        protected bool DoReleaseAgentCall(ulong regionHandle, UUID id, string uri)
+        {
+            //Console.WriteLine("   >>> DoReleaseAgentCall <<< " + uri);
+
+            WebRequest request = WebRequest.Create(uri);
+            request.Method = "DELETE";
+            request.Timeout = 10000;
+
+            try
+            {
+                WebResponse webResponse = request.GetResponse();
+                if (webResponse == null)
+                {
+                    m_log.Info("[REST COMMS]: Null reply on agent get ");
+                }
+
+                StreamReader sr = new StreamReader(webResponse.GetResponseStream());
+                //reply = sr.ReadToEnd().Trim();
+                sr.ReadToEnd().Trim();
+                sr.Close();
+                //m_log.InfoFormat("[REST COMMS]: ChilAgentUpdate reply was {0} ", reply);
+
+            }
+            catch (WebException ex)
+            {
+                m_log.InfoFormat("[REST COMMS]: exception on reply of agent get {0}", ex.Message);
+                // ignore, really
+            }
+
+            return true;
+        }
+
+        protected bool DoCloseAgentCall(RegionInfo region, UUID id)
+        {
+            string uri = "http://" + region.ExternalEndPoint.Address + ":" + region.HttpPort + "/agent/" + id + "/" + region.RegionHandle.ToString() +"/";
+
+            //Console.WriteLine("   >>> DoCloseAgentCall <<< " + uri);
+
+            WebRequest request = WebRequest.Create(uri);
+            request.Method = "DELETE";
+            request.Timeout = 10000;
+
+            try
+            {
+                WebResponse webResponse = request.GetResponse();
+                if (webResponse == null)
+                {
+                    m_log.Info("[REST COMMS]: Null reply on agent get ");
+                }
+
+                StreamReader sr = new StreamReader(webResponse.GetResponseStream());
+                //reply = sr.ReadToEnd().Trim();
+                sr.ReadToEnd().Trim();
+                sr.Close();
+                //m_log.InfoFormat("[REST COMMS]: ChilAgentUpdate reply was {0} ", reply);
+
+            }
+            catch (WebException ex)
+            {
+                m_log.InfoFormat("[REST COMMS]: exception on reply of agent get {0}", ex.Message);
+                // ignore, really
+            }
+
+            return true;
+        }
+        
+        protected bool DoCreateObjectCall(RegionInfo region, ISceneObject sog)
+        {
+            ulong regionHandle = GetRegionHandle(region.RegionHandle);
+            string uri = "http://" + region.ExternalEndPoint.Address + ":" + region.HttpPort + "/object/" + sog.UUID + "/" + regionHandle.ToString() + "/";
+            //Console.WriteLine("   >>> DoCreateChildAgentCall <<< " + uri);
+
+            WebRequest ObjectCreateRequest = WebRequest.Create(uri);
+            ObjectCreateRequest.Method = "POST";
+            ObjectCreateRequest.ContentType = "text/xml";
+            ObjectCreateRequest.Timeout = 10000;
+
+            OSDMap args = new OSDMap(2);
+            args["sog"] = OSD.FromString(sog.ToXmlString2());
+            args["extra"] = OSD.FromString(sog.ExtraToXmlString());
+            if (m_aScene.m_allowScriptCrossings)
+            {
+                string state = sog.GetStateSnapshot();
+                if (state.Length > 0)
+                    args["state"] = OSD.FromString(state);
+            }
+
+            string strBuffer = "";
+            byte[] buffer = new byte[1];
+            try
+            {
+                strBuffer = OSDParser.SerializeJsonString(args);
+                System.Text.UTF8Encoding str = new System.Text.UTF8Encoding();
+                buffer = str.GetBytes(strBuffer);
+
+            }
+            catch (Exception e)
+            {
+                m_log.WarnFormat("[REST COMMS]: Exception thrown on serialization of CreateObject: {0}", e.Message);
+                // ignore. buffer will be empty, caller should check.
+            }
+
+            Stream os = null;
+            try
+            { // send the Post
+                ObjectCreateRequest.ContentLength = buffer.Length;   //Count bytes to send
+                os = ObjectCreateRequest.GetRequestStream();
+                os.Write(buffer, 0, strBuffer.Length);         //Send it
+                os.Close();
+                m_log.InfoFormat("[REST COMMS]: Posted ChildAgentUpdate request to remote sim {0}", uri);
+            }
+            //catch (WebException ex)
+            catch
+            {
+               // m_log.InfoFormat("[REST COMMS]: Bad send on CreateObject {0}", ex.Message);
+
+                return false;
+            }
+
+            // Let's wait for the response
+            //m_log.Info("[REST COMMS]: Waiting for a reply after DoCreateChildAgentCall");
+
+            try
+            {
+                WebResponse webResponse = ObjectCreateRequest.GetResponse();
+                if (webResponse == null)
+                {
+                    m_log.Info("[REST COMMS]: Null reply on DoCreateObjectCall post");
+                }
+
+                StreamReader sr = new StreamReader(webResponse.GetResponseStream());
+                //reply = sr.ReadToEnd().Trim();
+                sr.ReadToEnd().Trim();
+                sr.Close();
+                //m_log.InfoFormat("[REST COMMS]: DoCreateChildAgentCall reply was {0} ", reply);
+
+            }
+            catch (WebException ex)
+            {
+                m_log.InfoFormat("[REST COMMS]: exception on reply of DoCreateObjectCall {0}", ex.Message);
+                // ignore, really
+            }
+
+            return true;
+
+        }
+
+        #endregion /* Do Work */
+
+        #region Incoming calls from remote instances
+
+        /**
+         * Agent-related incoming calls
+         */
+
+        public Hashtable AgentHandler(Hashtable request)
+        {
+            //m_log.Debug("[CONNECTION DEBUGGING]: AgentHandler Called");
+
+            //Console.WriteLine("---------------------------");
+            //Console.WriteLine(" >> uri=" + request["uri"]);
+            //Console.WriteLine(" >> content-type=" + request["content-type"]);
+            //Console.WriteLine(" >> http-method=" + request["http-method"]);
+            //Console.WriteLine("---------------------------\n");
+
+            Hashtable responsedata = new Hashtable();
+            responsedata["content_type"] = "text/html";
+
+            UUID agentID;
+            string action;
+            ulong regionHandle;
+            if (!GetParams((string)request["uri"], out agentID, out regionHandle, out action))
+            {
+                m_log.InfoFormat("[REST COMMS]: Invalid parameters for agent message {0}", request["uri"]);
+                responsedata["int_response_code"] = 404;
+                responsedata["str_response_string"] = "false";
+
+                return responsedata;
+            }
+
+            // Next, let's parse the verb
+            string method = (string)request["http-method"];
+            if (method.Equals("PUT"))
+            {
+                DoAgentPut(request, responsedata);
+                return responsedata;
+            }
+            else if (method.Equals("POST"))
+            {
+                DoAgentPost(request, responsedata, agentID);
+                return responsedata;
+            }
+            else if (method.Equals("DELETE"))
+            {
+                DoAgentDelete(request, responsedata, agentID, action, regionHandle);
+
+                return responsedata;
+            }
+            else
+            {
+                m_log.InfoFormat("[REST COMMS]: method {0} not supported in agent message", method);
+                responsedata["int_response_code"] = 404;
+                responsedata["str_response_string"] = "false";
+
+                return responsedata;
+            }
+
+        }
+
+        protected OSDMap GetOSDMap(Hashtable request)
+        {
+            OSDMap args = null;
+            try
+            {
+                OSD buffer;
+                // We should pay attention to the content-type, but let's assume we know it's Json
+                buffer = OSDParser.DeserializeJson((string)request["body"]);
+                if (buffer.Type == OSDType.Map)
+                {
+                    args = (OSDMap)buffer;
+                    return args;
+                }
+                else
+                {
+                    // uh?
+                    m_log.Debug("[REST COMMS]: Got OSD of type " + buffer.Type.ToString());
+                    return null;
+                }
+            }
+            catch (Exception ex)
+            {
+                m_log.InfoFormat("[REST COMMS]: exception on parse of REST message {0}", ex.Message);
+                return null;
+            }
+        }
+
+        protected virtual void DoAgentPost(Hashtable request, Hashtable responsedata, UUID id)
+        {
+            OSDMap args = GetOSDMap(request);
+            if (args == null)
+            {
+                responsedata["int_response_code"] = 400;
+                responsedata["str_response_string"] = "false";
+                return;
+            }
+
+            // retrieve the regionhandle
+            ulong regionhandle = 0;
+            if (args["destination_handle"] != null)
+                UInt64.TryParse(args["destination_handle"].AsString(), out regionhandle);
+
+            AgentCircuitData aCircuit = new AgentCircuitData();
+            try
+            {
+                aCircuit.UnpackAgentCircuitData(args);
+            }
+            catch (Exception ex)
+            {
+                m_log.InfoFormat("[REST COMMS]: exception on unpacking ChildCreate message {0}", ex.Message);
+                return;
+            }
+
+            // This is the meaning of POST agent
+            AdjustUserInformation(aCircuit);
+            bool result = m_localBackend.SendCreateChildAgent(regionhandle, aCircuit);
+
+            responsedata["int_response_code"] = 200;
+            responsedata["str_response_string"] = result.ToString();
+        }
+
+        protected virtual void DoAgentPut(Hashtable request, Hashtable responsedata)
+        {
+            OSDMap args = GetOSDMap(request);
+            if (args == null)
+            {
+                responsedata["int_response_code"] = 400;
+                responsedata["str_response_string"] = "false";
+                return;
+            }
+
+            // retrieve the regionhandle
+            ulong regionhandle = 0;
+            if (args["destination_handle"] != null)
+                UInt64.TryParse(args["destination_handle"].AsString(), out regionhandle);
+
+            string messageType;
+            if (args["message_type"] != null)
+                messageType = args["message_type"].AsString();
+            else
+            {
+                m_log.Warn("[REST COMMS]: Agent Put Message Type not found. ");
+                messageType = "AgentData";
+            }
+
+            bool result = true;
+            if ("AgentData".Equals(messageType))
+            {
+                AgentData agent = new AgentData();
+                try
+                {
+                    agent.UnpackUpdateMessage(args);
+                }
+                catch (Exception ex)
+                {
+                    m_log.InfoFormat("[REST COMMS]: exception on unpacking ChildAgentUpdate message {0}", ex.Message);
+                    return;
+                }
+                //agent.Dump();
+                // This is one of the meanings of PUT agent
+                result = m_localBackend.SendChildAgentUpdate(regionhandle, agent);
+
+            }
+            else if ("AgentPosition".Equals(messageType))
+            {
+                AgentPosition agent = new AgentPosition();
+                try
+                {
+                    agent.UnpackUpdateMessage(args);
+                }
+                catch (Exception ex)
+                {
+                    m_log.InfoFormat("[REST COMMS]: exception on unpacking ChildAgentUpdate message {0}", ex.Message);
+                    return;
+                }
+                //agent.Dump();
+                // This is one of the meanings of PUT agent
+                result = m_localBackend.SendChildAgentUpdate(regionhandle, agent);
+
+            }
+
+
+
+            responsedata["int_response_code"] = 200;
+            responsedata["str_response_string"] = result.ToString();
+        }
+
+        protected virtual void DoAgentDelete(Hashtable request, Hashtable responsedata, UUID id, string action, ulong regionHandle)
+        {
+            //Console.WriteLine(" >>> DoDelete action:" + action + "; regionHandle:" + regionHandle);
+            
+            if (action.Equals("release"))
+                m_localBackend.SendReleaseAgent(regionHandle, id, "");
+            else
+                m_localBackend.SendCloseAgent(regionHandle, id);
+
+            responsedata["int_response_code"] = 200;
+            responsedata["str_response_string"] = "OpenSim agent " + id.ToString();
+        }
+
+        /**
+         * Object-related incoming calls
+         */
+
+        public Hashtable ObjectHandler(Hashtable request)
+        {
+            //m_log.Debug("[CONNECTION DEBUGGING]: ObjectHandler Called");
+
+            //Console.WriteLine("---------------------------");
+            //Console.WriteLine(" >> uri=" + request["uri"]);
+            //Console.WriteLine(" >> content-type=" + request["content-type"]);
+            //Console.WriteLine(" >> http-method=" + request["http-method"]);
+            //Console.WriteLine("---------------------------\n");
+
+            Hashtable responsedata = new Hashtable();
+            responsedata["content_type"] = "text/html";
+
+            UUID objectID;
+            string action;
+            ulong regionHandle;
+            if (!GetParams((string)request["uri"], out objectID, out regionHandle, out action))
+            {
+                m_log.InfoFormat("[REST COMMS]: Invalid parameters for object message {0}", request["uri"]);
+                responsedata["int_response_code"] = 404;
+                responsedata["str_response_string"] = "false";
+
+                return responsedata;
+            }
+
+            // Next, let's parse the verb
+            string method = (string)request["http-method"];
+            if (method.Equals("POST"))
+            {
+                DoObjectPost(request, responsedata, regionHandle);
+                return responsedata;
+            }
+            //else if (method.Equals("PUT"))
+            //{
+            //    DoObjectPut(request, responsedata, agentID);
+            //    return responsedata;
+            //}
+            //else if (method.Equals("DELETE"))
+            //{
+            //    DoObjectDelete(request, responsedata, agentID, action, regionHandle);
+            //    return responsedata;
+            //}
+            else
+            {
+                m_log.InfoFormat("[REST COMMS]: method {0} not supported in object message", method);
+                responsedata["int_response_code"] = 404;
+                responsedata["str_response_string"] = "false";
+
+                return responsedata;
+            }
+
+        }
+
+        protected virtual void DoObjectPost(Hashtable request, Hashtable responsedata, ulong regionhandle)
+        {
+            OSDMap args = GetOSDMap(request);
+            if (args == null)
+            {
+                responsedata["int_response_code"] = 400;
+                responsedata["str_response_string"] = "false";
+                return;
+            }
+
+            string sogXmlStr = "", extraStr = "", stateXmlStr = "";
+            if (args["sog"] != null)
+                sogXmlStr = args["sog"].AsString();
+            if (args["extra"] != null)
+                extraStr = args["extra"].AsString();
+
+            UUID regionID = m_localBackend.GetRegionID(regionhandle);
+            SceneObjectGroup sog = null; 
+            try
+            {
+                sog = new SceneObjectGroup(sogXmlStr);
+                sog.ExtraFromXmlString(extraStr);
+            }
+            catch (Exception ex)
+            {
+                m_log.InfoFormat("[REST COMMS]: exception on deserializing scene object {0}", ex.Message);
+                responsedata["int_response_code"] = 400;
+                responsedata["str_response_string"] = "false";
+                return;
+            }
+
+            if ((args["state"] != null) && m_aScene.m_allowScriptCrossings)
+            {
+                stateXmlStr = args["state"].AsString();
+                if (stateXmlStr != "")
+                {
+                    try
+                    {
+                        sog.SetState(stateXmlStr, regionID);
+                    }
+                    catch (Exception ex)
+                    {
+                        m_log.InfoFormat("[REST COMMS]: exception on setting state for scene object {0}", ex.Message);
+
+                    }
+                }
+            }
+            // This is the meaning of POST object
+            bool result = m_localBackend.SendCreateObject(regionhandle, sog);
+
+            responsedata["int_response_code"] = 200;
+            responsedata["str_response_string"] = result.ToString();
+        }
+
+        #endregion 
+
+        #region Misc
+        
+        /// <summary>
+        /// Extract the param from an uri.
+        /// </summary>
+        /// <param name="uri">Something like this: /agent/uuid/ or /agent/uuid/handle/release</param>
+        /// <param name="uri">uuid on uuid field</param>
+        /// <param name="action">optional action</param>
+        protected bool GetParams(string uri, out UUID uuid, out ulong regionHandle, out string action)
+        {
+            uuid = UUID.Zero;
+            action = "";
+            regionHandle = 0;
+
+            uri = uri.Trim(new char[] { '/' });
+            string[] parts = uri.Split('/');
+            if (parts.Length <= 1)
+            {
+                return false;
+            }
+            else
+            {
+                if (!UUID.TryParse(parts[1], out uuid))
+                    return false;
+
+                if (parts.Length >= 3)
+                    UInt64.TryParse(parts[2], out regionHandle);
+                if (parts.Length >= 4)
+                    action = parts[3];
+                
+                return true;
+            }
+        }
+
+        #endregion Misc 
+
+        #region Hyperlinks
+
+        protected virtual ulong GetRegionHandle(ulong handle)
+        {
+            if (m_aScene.SceneGridService is HGSceneCommunicationService)
+                return ((HGSceneCommunicationService)(m_aScene.SceneGridService)).m_hg.FindRegionHandle(handle);
+
+            return handle;
+        }
+
+        protected virtual bool IsHyperlink(ulong handle)
+        {
+            if (m_aScene.SceneGridService is HGSceneCommunicationService)
+                return ((HGSceneCommunicationService)(m_aScene.SceneGridService)).m_hg.IsHyperlinkRegion(handle);
+
+            return false;
+        }
+
+        protected virtual void SendUserInformation(RegionInfo regInfo, AgentCircuitData aCircuit)
+        {
+            try
+            {
+                //if (IsHyperlink(regInfo.RegionHandle))
+                if (m_aScene.SceneGridService is HGSceneCommunicationService)
+                {
+                    ((HGSceneCommunicationService)(m_aScene.SceneGridService)).m_hg.SendUserInformation(regInfo, aCircuit);
+                }
+            }
+            catch // Bad cast
+            { }
+
+        }
+
+        protected virtual void AdjustUserInformation(AgentCircuitData aCircuit)
+        {
+            if (m_aScene.SceneGridService is HGSceneCommunicationService)
+                ((HGSceneCommunicationService)(m_aScene.SceneGridService)).m_hg.AdjustUserInformation(aCircuit);
+        }
+        #endregion /* Hyperlinks */
+
+    }
+}