Extend scripts stop/start/suspend/resume console commands to allow action on a single script by giving the script item id (which can be found via scripts show).

Not an ideal way to do this on a region with many scripts.  Needs refinement later.
0.7.2-post-fixes
Justin Clark-Casey (justincc) 2011-10-19 22:30:31 +01:00
parent c404760731
commit 1b32d5c6a4
2 changed files with 100 additions and 72 deletions

View File

@ -41,12 +41,16 @@ namespace OpenSim.Region.Framework.Interfaces
bool PostScriptEvent(UUID itemID, string name, Object[] args);
bool PostObjectEvent(UUID itemID, string name, Object[] args);
// Suspend ALL scripts in a given scene object. The item ID
// is the UUID of a SOG, and the method acts on all contained
// scripts. This is different from the suspend/resume that
// can be issued by a client.
//
/// <summary>
/// Suspends a script.
/// </summary>
/// <param name="itemID">The item ID of the script.</param>
void SuspendScript(UUID itemID);
/// <summary>
/// Resumes a script.
/// </summary>
/// <param name="itemID">The item ID of the script.</param>
void ResumeScript(UUID itemID);
ArrayList GetScriptErrors(UUID itemID);

View File

@ -276,25 +276,31 @@ namespace OpenSim.Region.ScriptEngine.XEngine
"Synonym for scripts show command", HandleShowScripts);
MainConsole.Instance.Commands.AddCommand(
"scripts", false, "scripts suspend", "scripts suspend", "Suspends all running scripts",
"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.",
HandleSuspendScripts);
+ "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", "Resumes all suspended scripts",
"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.",
HandleResumeScripts);
+ "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", "Stops all running scripts",
HandleStopScripts);
"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", "Starts all stopped scripts",
HandleStartScripts);
"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)
@ -334,11 +340,53 @@ namespace OpenSim.Region.ScriptEngine.XEngine
}
}
public void HandleSuspendScripts(string module, string[] cmdparams)
/// <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)
{
MainConsole.Instance.OutputFormat("Error - No item found with id {0}", itemId);
return;
}
else
{
action(instance);
return;
}
}
}
}
private void HandleSuspendScript(IScriptInstance instance)
{
if (!instance.Suspended)
{
@ -350,14 +398,8 @@ namespace OpenSim.Region.ScriptEngine.XEngine
instance.PrimName, instance.ScriptName, instance.ItemID, instance.ObjectID, sop.AbsolutePosition);
}
}
}
}
public void HandleResumeScripts(string module, string[] cmdparams)
{
lock (m_Scripts)
{
foreach (IScriptInstance instance in m_Scripts.Values)
private void HandleResumeScript(IScriptInstance instance)
{
if (instance.Suspended)
{
@ -369,14 +411,8 @@ namespace OpenSim.Region.ScriptEngine.XEngine
instance.PrimName, instance.ScriptName, instance.ItemID, instance.ObjectID, sop.AbsolutePosition);
}
}
}
}
public void HandleStartScripts(string module, string[] cmdparams)
{
lock (m_Scripts)
{
foreach (IScriptInstance instance in m_Scripts.Values)
private void HandleStartScript(IScriptInstance instance)
{
if (!instance.Running)
{
@ -388,14 +424,8 @@ namespace OpenSim.Region.ScriptEngine.XEngine
instance.PrimName, instance.ScriptName, instance.ItemID, instance.ObjectID, sop.AbsolutePosition);
}
}
}
}
public void HandleStopScripts(string module, string[] cmdparams)
{
lock (m_Scripts)
{
foreach (IScriptInstance instance in m_Scripts.Values)
private void HandleStopScript(IScriptInstance instance)
{
if (instance.Running)
{
@ -407,8 +437,6 @@ namespace OpenSim.Region.ScriptEngine.XEngine
instance.PrimName, instance.ScriptName, instance.ItemID, instance.ObjectID, sop.AbsolutePosition);
}
}
}
}
public void RemoveRegion(Scene scene)
{
@ -1770,18 +1798,14 @@ namespace OpenSim.Region.ScriptEngine.XEngine
public void SuspendScript(UUID itemID)
{
IScriptInstance instance = GetInstance(itemID);
if (instance == null)
return;
if (instance != null)
instance.Suspend();
}
public void ResumeScript(UUID itemID)
{
IScriptInstance instance = GetInstance(itemID);
if (instance == null)
return;
if (instance != null)
instance.Resume();
}
}