1 files changed, 300 insertions, 40 deletions

diff --git a/OpenSim/Region/ScriptEngine/XEngine/XEngine.cs b/OpenSim/Region/ScriptEngine/XEngine/XEngine.cs
index c8f6559..65c7416 100644
--- a/OpenSim/Region/ScriptEngine/XEngine/XEngine.cs
+++ b/OpenSim/Region/ScriptEngine/XEngine/XEngine.cs
@@ -42,7 +42,7 @@ using log4net;
 using Nini.Config;
 using Amib.Threading;
 using OpenSim.Framework;
-using OpenSim.Region.CoreModules.Framework.EventQueue;
+using OpenSim.Framework.Console;
 using OpenSim.Region.Framework.Scenes;
 using OpenSim.Region.Framework.Interfaces;
 using OpenSim.Region.ScriptEngine.Shared;
@@ -89,6 +89,12 @@ namespace OpenSim.Region.ScriptEngine.XEngine
         private IXmlRpcRouter m_XmlRpcRouter;
         private int m_EventLimit;
         private bool m_KillTimedOutScripts;
+        private string m_ScriptEnginesPath = null;
+
+        /// <summary>
+        /// Is the entire simulator in the process of shutting down?
+        /// </summary>
+        private bool m_SimulatorShuttingDown;
 
         private static List<XEngine> m_ScriptEngines =
                 new List<XEngine>();
@@ -224,6 +230,11 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             get { return m_ScriptConfig; }
         }
 
+        public string ScriptEnginePath
+        {
+            get { return m_ScriptEnginesPath; }
+        }
+
         public IConfigSource ConfigSource
         {
             get { return m_ConfigSource; }
@@ -281,6 +292,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             m_EventLimit = m_ScriptConfig.GetInt("EventLimit", 30);
             m_KillTimedOutScripts = m_ScriptConfig.GetBoolean("KillTimedOutScripts", false);
             m_SaveTime = m_ScriptConfig.GetInt("SaveInterval", 120) * 1000;
+            m_ScriptEnginesPath = m_ScriptConfig.GetString("ScriptEnginesPath", "ScriptEngines");
 
             m_Prio = ThreadPriority.BelowNormal;
             switch (priority)
@@ -327,10 +339,185 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                 OnScriptRemoved += m_XmlRpcRouter.ScriptRemoved;
                 OnObjectRemoved += m_XmlRpcRouter.ObjectRemoved;
             }
+
+            MainConsole.Instance.Commands.AddCommand(
+                "scripts", false, "scripts show", "scripts show", "Show script information",
+                "Show information on all scripts known to the script engine", HandleShowScripts);
+
+            MainConsole.Instance.Commands.AddCommand(
+                "scripts", false, "show scripts", "show scripts", "Show script information",
+                "Synonym for scripts show command", HandleShowScripts);
+
+            MainConsole.Instance.Commands.AddCommand(
+                "scripts", false, "scripts suspend", "scripts suspend [<script-item-uuid>]", "Suspends all running scripts",
+                "Suspends all currently running scripts.  This only suspends event delivery, it will not suspend a"
+                    + " script that is currently processing an event.\n"
+                    + "Suspended scripts will continue to accumulate events but won't process them.\n"
+                    + "If a <script-item-uuid> is given then only that script will be suspended.  Otherwise, all suitable scripts are suspended.",
+                 (module, cmdparams) => HandleScriptsAction(cmdparams, HandleSuspendScript));
+
+            MainConsole.Instance.Commands.AddCommand(
+                "scripts", false, "scripts resume", "scripts resume [<script-item-uuid>]", "Resumes all suspended scripts",
+                "Resumes all currently suspended scripts.\n"
+                    + "Resumed scripts will process all events accumulated whilst suspended."
+                    + "If a <script-item-uuid> is given then only that script will be resumed.  Otherwise, all suitable scripts are resumed.",
+                (module, cmdparams) => HandleScriptsAction(cmdparams, HandleResumeScript));
+
+            MainConsole.Instance.Commands.AddCommand(
+                "scripts", false, "scripts stop", "scripts stop [<script-item-uuid>]", "Stops all running scripts",
+                "Stops all running scripts."
+                    + "If a <script-item-uuid> is given then only that script will be stopped.  Otherwise, all suitable scripts are stopped.",
+                (module, cmdparams) => HandleScriptsAction(cmdparams, HandleStopScript));
+
+            MainConsole.Instance.Commands.AddCommand(
+                "scripts", false, "scripts start", "scripts start [<script-item-uuid>]", "Starts all stopped scripts",
+                "Starts all stopped scripts."
+                    + "If a <script-item-uuid> is given then only that script will be started.  Otherwise, all suitable scripts are started.",
+                (module, cmdparams) => HandleScriptsAction(cmdparams, HandleStartScript));
+        }
+
+        public void HandleShowScripts(string module, string[] cmdparams)
+        {
+            lock (m_Scripts)
+            {
+                MainConsole.Instance.OutputFormat(
+                    "Showing {0} scripts in {1}", m_Scripts.Count, m_Scene.RegionInfo.RegionName);
+
+                foreach (IScriptInstance instance in m_Scripts.Values)
+                {
+                    SceneObjectPart sop = m_Scene.GetSceneObjectPart(instance.ObjectID);
+                    string status;
+
+                    if (instance.ShuttingDown)
+                    {
+                        status = "shutting down";
+                    }
+                    else if (instance.Suspended)
+                    {
+                        status = "suspended";
+                    }
+                    else if (!instance.Running)
+                    {
+                        status = "stopped";
+                    }
+                    else
+                    {
+                        status = "running";
+                    }
+
+                    MainConsole.Instance.OutputFormat(
+                        "{0}.{1}, item UUID {2}, prim UUID {3} @ {4} ({5})",
+                        instance.PrimName, instance.ScriptName, instance.ItemID, instance.ObjectID,
+                        sop.AbsolutePosition, status);
+                }
+            }
+        }
+
+        /// <summary>
+        /// Parse the raw item id into a script instance from the command params if it's present.
+        /// </summary>
+        /// <param name="cmdparams"></param>
+        /// <param name="instance"></param>
+        /// <returns>true if we're okay to proceed, false if not.</returns>
+        private void HandleScriptsAction(string[] cmdparams, Action<IScriptInstance> action)
+        {
+            lock (m_Scripts)
+            {
+                string rawItemId;
+                UUID itemId = UUID.Zero;
+    
+                if (cmdparams.Length == 2)
+                {
+                    foreach (IScriptInstance instance in m_Scripts.Values)
+                        action(instance);
+
+                    return;
+                }
+    
+                rawItemId = cmdparams[2];
+    
+                if (!UUID.TryParse(rawItemId, out itemId))
+                {
+                    MainConsole.Instance.OutputFormat("Error - {0} is not a valid UUID", rawItemId);
+                    return;
+                }
+    
+                if (itemId != UUID.Zero)
+                {
+                    IScriptInstance instance = GetInstance(itemId);
+                    if (instance == null)
+                    {
+                        // Commented out for now since this will cause false reports on simulators with more than
+                        // one scene where the current command line set region is 'root' (which causes commands to
+                        // go to both regions... (sigh)
+//                        MainConsole.Instance.OutputFormat("Error - No item found with id {0}", itemId);
+                        return;
+                    }
+                    else
+                    {
+                        action(instance);
+                        return;
+                    }
+                }
+            }
+        }
+
+        private void HandleSuspendScript(IScriptInstance instance)
+        {
+            if (!instance.Suspended)
+            {
+                instance.Suspend();
+
+                SceneObjectPart sop = m_Scene.GetSceneObjectPart(instance.ObjectID);
+                MainConsole.Instance.OutputFormat(
+                    "Suspended {0}.{1}, item UUID {2}, prim UUID {3} @ {4}",
+                    instance.PrimName, instance.ScriptName, instance.ItemID, instance.ObjectID, sop.AbsolutePosition);
+            }
+        }
+
+        private void HandleResumeScript(IScriptInstance instance)
+        {
+            if (instance.Suspended)
+            {
+                instance.Resume();
+
+                SceneObjectPart sop = m_Scene.GetSceneObjectPart(instance.ObjectID);
+                MainConsole.Instance.OutputFormat(
+                    "Resumed {0}.{1}, item UUID {2}, prim UUID {3} @ {4}",
+                    instance.PrimName, instance.ScriptName, instance.ItemID, instance.ObjectID, sop.AbsolutePosition);
+            }
+        }
+
+        private void HandleStartScript(IScriptInstance instance)
+        {
+            if (!instance.Running)
+            {
+                instance.Start();
+
+                SceneObjectPart sop = m_Scene.GetSceneObjectPart(instance.ObjectID);
+                MainConsole.Instance.OutputFormat(
+                    "Started {0}.{1}, item UUID {2}, prim UUID {3} @ {4}",
+                    instance.PrimName, instance.ScriptName, instance.ItemID, instance.ObjectID, sop.AbsolutePosition);
+            }
+        }
+
+        private void HandleStopScript(IScriptInstance instance)
+        {
+            if (instance.Running)
+            {
+                instance.Stop(0);
+
+                SceneObjectPart sop = m_Scene.GetSceneObjectPart(instance.ObjectID);
+                MainConsole.Instance.OutputFormat(
+                    "Stopped {0}.{1}, item UUID {2}, prim UUID {3} @ {4}",
+                    instance.PrimName, instance.ScriptName, instance.ItemID, instance.ObjectID, sop.AbsolutePosition);
+            }
         }
 
         public void RemoveRegion(Scene scene)
         {
+            if (!m_Enabled)
+                return;
             lockScriptsForRead(true);
             foreach (IScriptInstance instance in m_Scripts.Values)
             {
@@ -355,12 +542,20 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                 // Must be done explicitly because they have infinite
                 // lifetime
                 //
-                m_DomainScripts[instance.AppDomain].Remove(instance.ItemID);
-                if (m_DomainScripts[instance.AppDomain].Count == 0)
+                if (!m_SimulatorShuttingDown)
                 {
-                    m_DomainScripts.Remove(instance.AppDomain);
-                    UnloadAppDomain(instance.AppDomain);
+                    m_DomainScripts[instance.AppDomain].Remove(instance.ItemID);
+                    if (m_DomainScripts[instance.AppDomain].Count == 0)
+                    {
+                        m_DomainScripts.Remove(instance.AppDomain);
+                        UnloadAppDomain(instance.AppDomain);
+                    }
                 }
+
+                m_Scripts.Clear();
+                m_PrimObjects.Clear();
+                m_Assemblies.Clear();
+                m_DomainScripts.Clear();
             }
             lockScriptsForRead(false);
             lockScriptsForWrite(true);
@@ -403,12 +598,18 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                 m_ThreadPool.QueueWorkItem(new WorkItemCallback(this.DoBackup),
                                            new Object[] { m_SaveTime });
             }
+        }
 
+        public void StartProcessing()
+        {
             m_ThreadPool.Start();
         }
 
         public void Close()
         {
+            if (!m_Enabled)
+                return;
+            
             lock (m_ScriptEngines)
             {
                 if (m_ScriptEngines.Contains(this))
@@ -455,11 +656,8 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             return 0;
         }
 
-        public object DoMaintenance(object p)
+        public void SaveAllState()
         {
-            object[] parms = (object[])p;
-            int sleepTime = (int)parms[0];
-
             foreach (IScriptInstance inst in m_Scripts.Values)
             {
                 if (inst.EventTime() > m_EventLimit)
@@ -469,6 +667,14 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                         inst.Start();
                 }
             }
+        }
+
+        public object DoMaintenance(object p)
+        {
+            object[] parms = (object[])p;
+            int sleepTime = (int)parms[0];
+
+            SaveAllState();
 
             System.Threading.Thread.Sleep(sleepTime);
 
@@ -478,7 +684,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             return 0;
         }
 
-        public Type ReplaceableInterface 
+        public Type ReplaceableInterface
         {
             get { return null; }
         }
@@ -632,7 +838,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             bool postOnRez = (bool)p[4];
             StateSource stateSource = (StateSource)p[5];
 
-            lock(m_CompileDict)
+            lock (m_CompileDict)
             {
                 if (!m_CompileDict.ContainsKey(itemID))
                     return false;
@@ -648,7 +854,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             SceneObjectPart part = m_Scene.GetSceneObjectPart(localID);
             if (part == null)
             {
-                m_log.Error("[Script] SceneObjectPart unavailable. Script NOT started.");
+                m_log.ErrorFormat("[Script]: SceneObjectPart with localID {0} unavailable. Script NOT started.", localID);
                 m_ScriptErrorMessage += "SceneObjectPart unavailable. Script NOT started.\n";
                 m_ScriptFailCount++;
                 return false;
@@ -769,8 +975,6 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                 }
             }
 
-            
-
             ScriptInstance instance = null;
             // Create the object record
             lockScriptsForRead(true);
@@ -789,9 +993,9 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                     try
                     {
                         AppDomainSetup appSetup = new AppDomainSetup();
-                        //                            appSetup.ApplicationBase = Path.Combine(
-                        //                                    "ScriptEngines",
-                        //                                    m_Scene.RegionInfo.RegionID.ToString());
+                        appSetup.PrivateBinPath = Path.Combine(
+                                m_ScriptEnginesPath,
+                                m_Scene.RegionInfo.RegionID.ToString());
 
                         Evidence baseEvidence = AppDomain.CurrentDomain.Evidence;
                         Evidence evidence = new Evidence(baseEvidence);
@@ -840,8 +1044,10 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                                               item.Name, startParam, postOnRez,
                                               stateSource, m_MaxScriptQueue);
 
-                m_log.DebugFormat("[XEngine] Loaded script {0}.{1}, script UUID {2}, prim UUID {3} @ {4}",
-                        part.ParentGroup.RootPart.Name, item.Name, assetID, part.UUID, part.ParentGroup.RootPart.AbsolutePosition.ToString());
+                m_log.DebugFormat(
+                        "[XEngine] Loaded script {0}.{1}, script UUID {2}, prim UUID {3} @ {4}.{5}",
+                        part.ParentGroup.RootPart.Name, item.Name, assetID, part.UUID, 
+                        part.ParentGroup.RootPart.AbsolutePosition, part.ParentGroup.Scene.RegionInfo.RegionName);
 
                 if (presence != null)
                 {
@@ -892,9 +1098,19 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                     m_CompileDict.Remove(itemID);
             }
 
-            lock (m_Scripts)
+            lockScriptsForRead(true);
+            // Do we even have it?
+            if (!m_Scripts.ContainsKey(itemID))
             {
+                // Do we even have it?
+                if (!m_Scripts.ContainsKey(itemID))
+                    return;
+
                 lockScriptsForRead(false);
+                lockScriptsForWrite(true);
+                m_Scripts.Remove(itemID);
+                lockScriptsForWrite(false);
+
                 return;
             }
              
@@ -948,7 +1164,6 @@ namespace OpenSim.Region.ScriptEngine.XEngine
 
             CleanAssemblies();
             
-
             ScriptRemoved handlerScriptRemoved = OnScriptRemoved;
             if (handlerScriptRemoved != null)
                 handlerScriptRemoved(itemID);
@@ -1039,7 +1254,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             startInfo.IdleTimeout = idleTimeout*1000; // convert to seconds as stated in .ini
             startInfo.MaxWorkerThreads = maxThreads;
             startInfo.MinWorkerThreads = minThreads;
-            startInfo.ThreadPriority = threadPriority;
+            startInfo.ThreadPriority = threadPriority;;
             startInfo.StackSize = stackSize;
             startInfo.StartSuspended = true;
 
@@ -1068,7 +1283,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
 
             IScriptInstance instance = (ScriptInstance) parms;
             
-            //m_log.DebugFormat("[XENGINE]: Processing event for {0}", instance);
+            //m_log.DebugFormat("[XEngine]: Processing event for {0}", instance);
 
             return instance.EventProcessor();
         }
@@ -1082,26 +1297,34 @@ namespace OpenSim.Region.ScriptEngine.XEngine
         public bool PostObjectEvent(uint localID, EventParams p)
         {
             bool result = false;
-            
+            List<UUID> uuids = null;
+
             lock (m_PrimObjects)
             {
                 if (!m_PrimObjects.ContainsKey(localID))
                     return false;
 
+                uuids = m_PrimObjects[localID];
             
-                foreach (UUID itemID in m_PrimObjects[localID])
+
+            foreach (UUID itemID in uuids)
+            {
+                IScriptInstance instance = null;
+                try
                 {
                     if (m_Scripts.ContainsKey(itemID))
-                    {
-                        IScriptInstance instance = m_Scripts[itemID];
-                        if (instance != null)
-                        {
-                            instance.PostEvent(p);
-                            result = true;
-                        }
-                    }
+                        instance = m_Scripts[itemID];
                 }
+                catch { /* ignore race conditions */ }
+
+                if (instance != null)
+                {
+                    instance.PostEvent(p);
+                    result = true;
+                }
+            }
             }
+            
             return result;
         }
 
@@ -1177,8 +1400,8 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             if (!(sender is System.AppDomain))
                 return null;
 
-            string[] pathList = new string[] {"bin", "ScriptEngines",
-                                              Path.Combine("ScriptEngines",
+            string[] pathList = new string[] {"bin", m_ScriptEnginesPath,
+                                              Path.Combine(m_ScriptEnginesPath,
                                                            m_Scene.RegionInfo.RegionID.ToString())};
 
             string assemblyName = args.Name;
@@ -1302,6 +1525,8 @@ namespace OpenSim.Region.ScriptEngine.XEngine
 
         public void OnShutdown()
         {
+            m_SimulatorShuttingDown = true;
+
             List<IScriptInstance> instances = new List<IScriptInstance>();
 
             lockScriptsForRead(true);
@@ -1346,16 +1571,22 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             }
             else
             {
-                eq.Enqueue(EventQueueHelper.ScriptRunningReplyEvent(objectID, itemID, GetScriptState(itemID), true),
+                eq.Enqueue(eq.ScriptRunningEvent(objectID, itemID, GetScriptState(itemID), true),
                            controllingClient.AgentId);
             }
         }
 
         public string GetXMLState(UUID itemID)
         {
+//            m_log.DebugFormat("[XEngine]: Getting XML state for {0}", itemID);
+
             IScriptInstance instance = GetInstance(itemID);
             if (instance == null)
+            {
+//                m_log.DebugFormat("[XEngine]: Found no script for {0}, returning empty string", itemID);
                 return "";
+            }
+
             string xml = instance.GetXMLState();
 
             XmlDocument sdoc = new XmlDocument();
@@ -1364,7 +1595,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             {
                 sdoc.LoadXml(xml);
             }
-            catch (System.Xml.XmlException e)
+            catch (System.Xml.XmlException)
             {
                 loadedState = false;
             }
@@ -1496,6 +1727,9 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             mapData.InnerText = map;
 
             stateData.AppendChild(mapData);
+
+//            m_log.DebugFormat("[XEngine]: Got XML state for {0}", itemID);
+
             return doc.InnerXml;
         }
 
@@ -1555,7 +1789,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                 string fn = assemE.GetAttribute("Filename");
                 string base64 = assemE.InnerText;
 
-                string path = Path.Combine("ScriptEngines", World.RegionInfo.RegionID.ToString());
+                string path = Path.Combine(m_ScriptEnginesPath, World.RegionInfo.RegionID.ToString());
                 path = Path.Combine(path, fn);
 
                 if (!File.Exists(path))
@@ -1595,7 +1829,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                 }
             }
 
-            string statepath = Path.Combine("ScriptEngines", World.RegionInfo.RegionID.ToString());
+            string statepath = Path.Combine(m_ScriptEnginesPath, World.RegionInfo.RegionID.ToString());
             statepath = Path.Combine(statepath, itemID.ToString() + ".state");
 
             try
@@ -1621,7 +1855,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             {
                 XmlElement mapE = (XmlElement)mapL[0];
 
-                string mappath = Path.Combine("ScriptEngines", World.RegionInfo.RegionID.ToString());
+                string mappath = Path.Combine(m_ScriptEnginesPath, World.RegionInfo.RegionID.ToString());
                 mappath = Path.Combine(mappath, mapE.GetAttribute("Filename"));
 
                 try
@@ -1661,5 +1895,31 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                 return new ArrayList();
             }
         }
+
+        public void SuspendScript(UUID itemID)
+        {
+            IScriptInstance instance = GetInstance(itemID);
+            if (instance != null)
+                instance.Suspend();
+        }
+
+        public void ResumeScript(UUID itemID)
+        {
+            IScriptInstance instance = GetInstance(itemID);
+            if (instance != null)
+                instance.Resume();
+        }
+
+        public bool HasScript(UUID itemID, out bool running)
+        {
+            running = true;
+
+            IScriptInstance instance = GetInstance(itemID);
+            if (instance == null)
+                return false;
+
+            running = instance.Running;
+            return true;
+        }
     }
 }