Add XmlRpcGridRouter, a module that communicates URIs for XMLRPC channels

to a central server via REST, for centralized XMLRPC routing.

OpenSim/Region/OptionalModules/Scripting/XmlRpcRouterModule/XmlRpcGridRouterModule.cs

@@ -0,0 +1,143 @@
+/*
+ * 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.Generic;
+using System.Reflection;
+
+using log4net;
+using Nini.Config;
+using OpenMetaverse;
+
+using OpenSim.Framework;
+using OpenSim.Framework.Communications;
+using OpenSim.Framework.Servers;
+using OpenSim.Framework.Client;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Region.Framework.Scenes;
+
+namespace OpenSim.Region.OptionalModules.Scripting.XmlRpcGridRouterModule
+{
+    public class XmlRpcInfo
+    {
+        public UUID channel;
+        public string uri;
+    }
+
+    public class XmlRpcGridRouter : IRegionModule, IXmlRpcRouter
+    {
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+        
+        private Dictionary<UUID, UUID> m_Channels =
+                new Dictionary<UUID, UUID>();
+
+        private bool m_Enabled = false;
+        private string m_ServerURI = String.Empty;
+
+        public void Initialise(Scene scene, IConfigSource config)
+        {
+            IConfig startupConfig = config.Configs["Startup"];
+            if (startupConfig == null)
+                return;
+
+            if (startupConfig.GetString("XmlRpcRouterModule",
+                    "XmlRpcRouterModule") == "XmlRpcGridRouterModule")
+            {
+                m_ServerURI = startupConfig.GetString("XmlRpcHubURI", String.Empty);
+                if (m_ServerURI == String.Empty)
+                {
+                    m_log.Error("[XMLRPC GRID ROUTER] Module configured but no URI given. Disabling");
+                    return;
+                }
+
+                scene.RegisterModuleInterface<IXmlRpcRouter>(this);
+                m_Enabled = true;
+            }
+        }
+
+        public void PostInitialise()
+        {
+        }
+
+        public void Close()
+        {
+        }
+
+        public string Name
+        {
+            get { return "XmlRpcGridRouterModule"; }
+        }
+
+        public bool IsSharedModule
+        {
+            get { return false; }
+        }
+
+        public void RegisterNewReceiver(IScriptModule scriptEngine, UUID channel, UUID objectID, UUID itemID, string uri)
+        {
+            if (!m_Channels.ContainsKey(itemID))
+            {
+                XmlRpcInfo info = new XmlRpcInfo();
+                info.channel = channel;
+                info.uri = uri;
+
+                bool success = SynchronousRestObjectPoster.BeginPostObject<XmlRpcInfo, bool>(
+                        "POST", m_ServerURI+"/RegisterChannel/", info);
+
+                if (!success)
+                {
+                    m_log.Error("[XMLRPC GRID ROUTER] Error contacting server");
+                }
+
+                m_Channels[itemID] = channel;
+            }
+        }
+
+        public void ScriptRemoved(UUID itemID)
+        {
+            if (!m_Enabled)
+                return;
+
+            if (m_Channels.ContainsKey(itemID))
+            {
+                bool success = SynchronousRestObjectPoster.BeginPostObject<UUID, bool>(
+                        "POST", m_ServerURI+"/RemoveChannel/", m_Channels[itemID]);
+
+                if (!success)
+                {
+                    m_log.Error("[XMLRPC GRID ROUTER] Error contacting server");
+                }
+
+                m_Channels.Remove(itemID);
+            }
+        }
+
+        public void ObjectRemoved(UUID objectID)
+        {
+        }
+    }
+}