* Applied patch from Melanie, mantis issue #1581 - "Refactor LSL language, api and compiler out of XEngine"

"First stage in a major Script Engine refactor, that will result in the LSL implementaions ebing reconverged. Not there yet, but one major part is done."
Thank you, Melanie!

1 files changed, 308 insertions, 0 deletions

diff --git a/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/AsyncCommandManager.cs b/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/AsyncCommandManager.cs
new file mode 100644
index 0000000..8c967a2
--- /dev/null
+++ b/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/AsyncCommandManager.cs
@@ -0,0 +1,308 @@
+/*
+ * 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.Threading;
+using libsecondlife;
+using OpenSim.Framework;
+using OpenSim.Region.Environment.Interfaces;
+using OpenSim.Region.ScriptEngine.Interfaces;
+using OpenSim.Region.ScriptEngine.Shared;
+using OpenSim.Region.ScriptEngine.Shared.Api.Plugins;
+using Timer=OpenSim.Region.ScriptEngine.Shared.Api.Plugins.Timer;
+
+namespace OpenSim.Region.ScriptEngine.Shared.Api
+{
+    /// <summary>
+    /// Handles LSL commands that takes long time and returns an event, for example timers, HTTP requests, etc.
+    /// </summary>
+    public class AsyncCommandManager
+    {
+        private static Thread cmdHandlerThread;
+        private static int cmdHandlerThreadCycleSleepms;
+
+        private static List<AsyncCommandManager> m_Managers = new List<AsyncCommandManager>();
+        public IScriptEngine m_ScriptEngine;
+
+        private Dataserver m_Dataserver;
+        private Timer m_Timer;
+        private HttpRequest m_HttpRequest;
+        private Listener m_Listener;
+        private SensorRepeat m_SensorRepeat;
+        private XmlRequest m_XmlRequest;
+
+        public Dataserver DataserverPlugin
+        {
+            get { return m_Dataserver; }
+        }
+
+        public Timer TimerPlugin
+        {
+            get { return m_Timer; }
+        }
+
+        public HttpRequest HttpRequestPlugin
+        {
+            get { return m_HttpRequest; }
+        }
+
+        public Listener ListenerPlugin
+        {
+            get { return m_Listener; }
+        }
+
+        public SensorRepeat SensorRepeatPlugin
+        {
+            get { return m_SensorRepeat; }
+        }
+
+        public XmlRequest XmlRequestPlugin
+        {
+            get { return m_XmlRequest; }
+        }
+
+        public AsyncCommandManager[] Managers
+        {
+            get { return m_Managers.ToArray(); }
+        }
+
+        public AsyncCommandManager(IScriptEngine _ScriptEngine)
+        {
+            m_ScriptEngine = _ScriptEngine;
+            if(!m_Managers.Contains(this))
+                m_Managers.Add(this);
+
+            ReadConfig();
+
+            // Create instances of all plugins
+            m_Dataserver = new Dataserver(this);
+            m_Timer = new Timer(this);
+            m_HttpRequest = new HttpRequest(this);
+            m_Listener = new Listener(this);
+            m_SensorRepeat = new SensorRepeat(this);
+            m_XmlRequest = new XmlRequest(this);
+
+            StartThread();
+        }
+
+        private static void StartThread()
+        {
+            if (cmdHandlerThread == null)
+            {
+                // Start the thread that will be doing the work
+                cmdHandlerThread = new Thread(CmdHandlerThreadLoop);
+                cmdHandlerThread.Name = "AsyncLSLCmdHandlerThread";
+                cmdHandlerThread.Priority = ThreadPriority.BelowNormal;
+                cmdHandlerThread.IsBackground = true;
+                cmdHandlerThread.Start();
+                ThreadTracker.Add(cmdHandlerThread);
+            }
+        }
+
+        public void ReadConfig()
+        {
+            cmdHandlerThreadCycleSleepms = m_ScriptEngine.Config.GetInt("AsyncLLCommandLoopms", 100);
+        }
+
+        ~AsyncCommandManager()
+        {
+            // Shut down thread
+            try
+            {
+                if (cmdHandlerThread != null)
+                {
+                    if (cmdHandlerThread.IsAlive == true)
+                    {
+                        cmdHandlerThread.Abort();
+                        //cmdHandlerThread.Join();
+                    }
+                }
+            }
+            catch
+            {
+            }
+        }
+
+        private static void CmdHandlerThreadLoop()
+        {
+            while (true)
+            {
+                try
+                {
+                    while (true)
+                    {
+                        Thread.Sleep(cmdHandlerThreadCycleSleepms);
+
+                        foreach (AsyncCommandManager m in m_Managers)
+                        {
+                            m.DoOneCmdHandlerPass();
+                        }
+                    }
+                }
+                catch
+                {
+                }
+            }
+        }
+
+        public void DoOneCmdHandlerPass()
+        {
+            // Check timers
+            m_Timer.CheckTimerEvents();
+            // Check HttpRequests
+            m_HttpRequest.CheckHttpRequests();
+            // Check XMLRPCRequests
+            m_XmlRequest.CheckXMLRPCRequests();
+            // Check Listeners
+            m_Listener.CheckListeners();
+            // Check Sensors
+            m_SensorRepeat.CheckSenseRepeaterEvents();
+            // Check dataserver
+            m_Dataserver.ExpireRequests();
+        }
+
+        /// <summary>
+        /// Remove a specific script (and all its pending commands)
+        /// </summary>
+        /// <param name="localID"></param>
+        /// <param name="itemID"></param>
+        public void RemoveScript(uint localID, LLUUID itemID)
+        {
+            // Remove a specific script
+
+            // Remove dataserver events
+            m_Dataserver.RemoveEvents(localID, itemID);
+
+            // Remove from: Timers
+            m_Timer.UnSetTimerEvents(localID, itemID);
+
+            // Remove from: HttpRequest
+            IHttpRequests iHttpReq =
+                m_ScriptEngine.World.RequestModuleInterface<IHttpRequests>();
+            iHttpReq.StopHttpRequest(localID, itemID);
+
+            IWorldComm comms = m_ScriptEngine.World.RequestModuleInterface<IWorldComm>();
+            comms.DeleteListener(itemID);
+
+            IXMLRPC xmlrpc = m_ScriptEngine.World.RequestModuleInterface<IXMLRPC>();
+            xmlrpc.DeleteChannels(itemID);
+            xmlrpc.CancelSRDRequests(itemID);
+
+            // Remove Sensors
+            m_SensorRepeat.UnSetSenseRepeaterEvents(localID, itemID);
+
+        }
+
+        public Object[] GetSerializationData(LLUUID itemID)
+        {
+            List<Object> data = new List<Object>();
+
+            Object[] listeners=m_Listener.GetSerializationData(itemID);
+            if (listeners.Length > 0)
+            {
+                data.Add("listener");
+                data.Add(listeners.Length);
+                data.AddRange(listeners);
+            }
+
+            Object[] timers=m_Timer.GetSerializationData(itemID);
+            if (timers.Length > 0)
+            {
+                data.Add("timer");
+                data.Add(timers.Length);
+                data.AddRange(timers);
+            }
+
+            Object[] sensors=m_SensorRepeat.GetSerializationData(itemID);
+            if (sensors.Length > 0)
+            {
+                data.Add("sensor");
+                data.Add(sensors.Length);
+                data.AddRange(sensors);
+            }
+
+            return data.ToArray();
+        }
+
+        public void CreateFromData(uint localID, LLUUID itemID, LLUUID hostID,
+                                   Object[] data)
+        {
+            int idx = 0;
+            int len;
+
+            while (idx < data.Length)
+            {
+                string type = data[idx].ToString();
+                len = (int)data[idx+1];
+                idx+=2;
+
+                if (len > 0)
+                {
+                    Object[] item = new Object[len];
+                    Array.Copy(data, idx, item, 0, len);
+
+                    idx+=len;
+
+                    switch (type)
+                    {
+                    case "listener":
+                        m_Listener.CreateFromData(localID, itemID, hostID,
+                                                  item);
+                        break;
+                    case "timer":
+                        m_Timer.CreateFromData(localID, itemID, hostID, item);
+                        break;
+                    case "sensor":
+                        m_SensorRepeat.CreateFromData(localID, itemID, hostID,
+                                                      item);
+                        break;
+                    }
+                }
+            }
+        }
+
+        #region Check llRemoteData channels
+
+        #endregion
+
+        #region Check llListeners
+
+        #endregion
+
+        /// <summary>
+        /// If set to true then threads and stuff should try to make a graceful exit
+        /// </summary>
+        public bool PleaseShutdown
+        {
+            get { return _PleaseShutdown; }
+            set { _PleaseShutdown = value; }
+        }
+        private bool _PleaseShutdown = false;
+    }
+}