XEngine.cs 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSim Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using System;
  28. using System.IO;
  29. using System.Threading;
  30. using System.Collections;
  31. using System.Collections.Generic;
  32. using System.Security;
  33. using System.Security.Policy;
  34. using System.Reflection;
  35. using System.Globalization;
  36. using System.Xml;
  37. using OpenMetaverse;
  38. using OpenMetaverse.StructuredData;
  39. using log4net;
  40. using Nini.Config;
  41. using Amib.Threading;
  42. using OpenSim.Framework;
  43. using OpenSim.Region.Interfaces;
  44. using OpenSim.Region.Environment;
  45. using OpenSim.Region.Environment.Scenes;
  46. using OpenSim.Region.Environment.Interfaces;
  47. using OpenSim.Region.ScriptEngine.Shared;
  48. using OpenSim.Region.ScriptEngine.Shared.ScriptBase;
  49. using OpenSim.Region.ScriptEngine.Shared.CodeTools;
  50. using OpenSim.Region.ScriptEngine.Shared.Instance;
  51. using OpenSim.Region.ScriptEngine.Interfaces;
  52. namespace OpenSim.Region.ScriptEngine.XEngine
  53. {
  54. public class XEngine : IRegionModule, IScriptModule, IScriptEngine
  55. {
  56. private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
  57. private SmartThreadPool m_ThreadPool;
  58. private int m_MaxScriptQueue;
  59. private Scene m_Scene;
  60. private IConfig m_ScriptConfig;
  61. private ICompiler m_Compiler;
  62. private int m_MinThreads;
  63. private int m_MaxThreads ;
  64. private int m_IdleTimeout;
  65. private int m_StackSize;
  66. private int m_SleepTime;
  67. private int m_SaveTime;
  68. private ThreadPriority m_Prio;
  69. private bool m_Enabled = false;
  70. private bool m_InitialStartup = true;
  71. // disable warning: need to keep a reference to XEngine.EventManager
  72. // alive to avoid it being garbage collected
  73. #pragma warning disable 414
  74. private EventManager m_EventManager;
  75. #pragma warning restore 414
  76. private int m_EventLimit;
  77. private bool m_KillTimedOutScripts;
  78. private static List<XEngine> m_ScriptEngines =
  79. new List<XEngine>();
  80. // Maps the local id to the script inventory items in it
  81. private Dictionary<uint, List<UUID> > m_PrimObjects =
  82. new Dictionary<uint, List<UUID> >();
  83. // Maps the UUID above to the script instance
  84. private Dictionary<UUID, IScriptInstance> m_Scripts =
  85. new Dictionary<UUID, IScriptInstance>();
  86. // Maps the asset ID to the assembly
  87. private Dictionary<UUID, string> m_Assemblies =
  88. new Dictionary<UUID, string>();
  89. // This will list AppDomains by script asset
  90. private Dictionary<UUID, AppDomain> m_AppDomains =
  91. new Dictionary<UUID, AppDomain>();
  92. // List the scripts running in each appdomain
  93. private Dictionary<UUID, List<UUID> > m_DomainScripts =
  94. new Dictionary<UUID, List<UUID> >();
  95. private Queue m_CompileQueue = new Queue(100);
  96. IWorkItemResult m_CurrentCompile = null;
  97. public string ScriptEngineName
  98. {
  99. get { return "XEngine"; }
  100. }
  101. public Scene World
  102. {
  103. get { return m_Scene; }
  104. }
  105. public ILog Log
  106. {
  107. get { return m_log; }
  108. }
  109. public static List<XEngine> ScriptEngines
  110. {
  111. get { return m_ScriptEngines; }
  112. }
  113. // private struct RezScriptParms
  114. // {
  115. // uint LocalID;
  116. // UUID ItemID;
  117. // string Script;
  118. // }
  119. public IConfig Config
  120. {
  121. get { return m_ScriptConfig; }
  122. }
  123. //
  124. // IRegionModule functions
  125. //
  126. public void Initialise(Scene scene, IConfigSource configSource)
  127. {
  128. m_ScriptConfig = configSource.Configs["XEngine"];
  129. if (m_ScriptConfig == null)
  130. {
  131. // m_log.ErrorFormat("[XEngine] No script configuration found. Scripts disabled");
  132. return;
  133. }
  134. m_Enabled = m_ScriptConfig.GetBoolean("Enabled", true);
  135. if (!m_Enabled)
  136. return;
  137. AppDomain.CurrentDomain.AssemblyResolve +=
  138. OnAssemblyResolve;
  139. m_log.InfoFormat("[XEngine] Initializing scripts in region {0}",
  140. scene.RegionInfo.RegionName);
  141. m_Scene = scene;
  142. m_MinThreads = m_ScriptConfig.GetInt("MinThreads", 2);
  143. m_MaxThreads = m_ScriptConfig.GetInt("MaxThreads", 100);
  144. m_IdleTimeout = m_ScriptConfig.GetInt("IdleTimeout", 60);
  145. string priority = m_ScriptConfig.GetString("Priority", "BelowNormal");
  146. m_MaxScriptQueue = m_ScriptConfig.GetInt("MaxScriptEventQueue",300);
  147. m_StackSize = m_ScriptConfig.GetInt("ThreadStackSize", 262144);
  148. m_SleepTime = m_ScriptConfig.GetInt("MaintenanceInterval", 10) * 1000;
  149. m_EventLimit = m_ScriptConfig.GetInt("EventLimit", 30);
  150. m_KillTimedOutScripts = m_ScriptConfig.GetBoolean("KillTimedOutScripts", false);
  151. m_SaveTime = m_ScriptConfig.GetInt("SaveInterval", 120) * 1000;
  152. m_Prio = ThreadPriority.BelowNormal;
  153. switch (priority)
  154. {
  155. case "Lowest":
  156. m_Prio = ThreadPriority.Lowest;
  157. break;
  158. case "BelowNormal":
  159. m_Prio = ThreadPriority.BelowNormal;
  160. break;
  161. case "Normal":
  162. m_Prio = ThreadPriority.Normal;
  163. break;
  164. case "AboveNormal":
  165. m_Prio = ThreadPriority.AboveNormal;
  166. break;
  167. case "Highest":
  168. m_Prio = ThreadPriority.Highest;
  169. break;
  170. default:
  171. m_log.ErrorFormat("[XEngine] Invalid thread priority: '{0}'. Assuming BelowNormal", priority);
  172. break;
  173. }
  174. lock (m_ScriptEngines)
  175. {
  176. m_ScriptEngines.Add(this);
  177. }
  178. // Needs to be here so we can queue the scripts that need starting
  179. //
  180. m_Scene.EventManager.OnRezScript += OnRezScript;
  181. // Complete basic setup of the thread pool
  182. //
  183. SetupEngine(m_MinThreads, m_MaxThreads, m_IdleTimeout, m_Prio,
  184. m_MaxScriptQueue, m_StackSize);
  185. m_Scene.StackModuleInterface<IScriptModule>(this);
  186. }
  187. public void PostInitialise()
  188. {
  189. if (!m_Enabled)
  190. return;
  191. m_EventManager = new EventManager(this);
  192. m_Compiler = new Compiler(this);
  193. m_Scene.EventManager.OnRemoveScript += OnRemoveScript;
  194. m_Scene.EventManager.OnScriptReset += OnScriptReset;
  195. m_Scene.EventManager.OnStartScript += OnStartScript;
  196. m_Scene.EventManager.OnStopScript += OnStopScript;
  197. m_Scene.EventManager.OnGetScriptRunning += OnGetScriptRunning;
  198. m_Scene.EventManager.OnShutdown += OnShutdown;
  199. if (m_SleepTime > 0)
  200. {
  201. m_ThreadPool.QueueWorkItem(new WorkItemCallback(this.DoMaintenance),
  202. new Object[]{ m_SleepTime });
  203. }
  204. if (m_SaveTime > 0)
  205. {
  206. m_ThreadPool.QueueWorkItem(new WorkItemCallback(this.DoBackup),
  207. new Object[] { m_SaveTime });
  208. }
  209. m_ThreadPool.Start();
  210. }
  211. public void Close()
  212. {
  213. lock (m_ScriptEngines)
  214. {
  215. if (m_ScriptEngines.Contains(this))
  216. m_ScriptEngines.Remove(this);
  217. }
  218. }
  219. public object DoBackup(object o)
  220. {
  221. Object[] p = (Object[])o;
  222. int saveTime = (int)p[0];
  223. if (saveTime > 0)
  224. System.Threading.Thread.Sleep(saveTime);
  225. // m_log.Debug("[XEngine] Backing up script states");
  226. List<IScriptInstance> instances = new List<IScriptInstance>();
  227. lock (m_Scripts)
  228. {
  229. foreach (IScriptInstance instance in m_Scripts.Values)
  230. instances.Add(instance);
  231. }
  232. foreach (IScriptInstance i in instances)
  233. {
  234. string assembly = String.Empty;
  235. lock (m_Scripts)
  236. {
  237. if (!m_Assemblies.ContainsKey(i.AssetID))
  238. continue;
  239. assembly = m_Assemblies[i.AssetID];
  240. }
  241. i.SaveState(assembly);
  242. }
  243. instances.Clear();
  244. if (saveTime > 0)
  245. m_ThreadPool.QueueWorkItem(new WorkItemCallback(this.DoBackup),
  246. new Object[] { saveTime });
  247. return 0;
  248. }
  249. public object DoMaintenance(object p)
  250. {
  251. object[] parms = (object[])p;
  252. int sleepTime = (int)parms[0];
  253. foreach (IScriptInstance inst in m_Scripts.Values)
  254. {
  255. if (inst.EventTime() > m_EventLimit)
  256. {
  257. inst.Stop(100);
  258. if (!m_KillTimedOutScripts)
  259. inst.Start();
  260. }
  261. }
  262. System.Threading.Thread.Sleep(sleepTime);
  263. m_ThreadPool.QueueWorkItem(new WorkItemCallback(this.DoMaintenance),
  264. new Object[]{ sleepTime });
  265. return 0;
  266. }
  267. public string Name
  268. {
  269. get { return "XEngine"; }
  270. }
  271. public bool IsSharedModule
  272. {
  273. get { return false; }
  274. }
  275. public void OnRezScript(uint localID, UUID itemID, string script, int startParam, bool postOnRez, string engine, int stateSource)
  276. {
  277. List<IScriptModule> engines = new List<IScriptModule>(m_Scene.RequestModuleInterfaces<IScriptModule>());
  278. List<string> names = new List<string>();
  279. foreach (IScriptModule m in engines)
  280. names.Add(m.ScriptEngineName);
  281. int lineEnd = script.IndexOf('\n');
  282. if (lineEnd > 1)
  283. {
  284. string firstline = script.Substring(0, lineEnd).Trim();
  285. int colon = firstline.IndexOf(':');
  286. if (firstline.Length > 2 && firstline.Substring(0, 2) == "//" && colon != -1)
  287. {
  288. string engineName = firstline.Substring(2, colon-2);
  289. if (names.Contains(engineName))
  290. {
  291. engine = engineName;
  292. script = "//" + script.Substring(script.IndexOf(':')+1);
  293. }
  294. else
  295. {
  296. if (engine == ScriptEngineName)
  297. {
  298. SceneObjectPart part =
  299. m_Scene.GetSceneObjectPart(
  300. localID);
  301. TaskInventoryItem item =
  302. part.Inventory.GetInventoryItem(itemID);
  303. ScenePresence presence =
  304. m_Scene.GetScenePresence(
  305. item.OwnerID);
  306. if (presence != null)
  307. {
  308. presence.ControllingClient.SendAgentAlertMessage(
  309. "Selected engine unavailable. "+
  310. "Running script on "+
  311. ScriptEngineName,
  312. false);
  313. }
  314. }
  315. }
  316. }
  317. }
  318. if (engine != ScriptEngineName)
  319. return;
  320. Object[] parms = new Object[]{localID, itemID, script, startParam, postOnRez, (StateSource)stateSource};
  321. if (stateSource == (int)StateSource.ScriptedRez)
  322. {
  323. DoOnRezScript(parms);
  324. }
  325. else
  326. {
  327. lock (m_CompileQueue)
  328. {
  329. m_CompileQueue.Enqueue(parms);
  330. if (m_CurrentCompile == null)
  331. {
  332. m_CurrentCompile = m_ThreadPool.QueueWorkItem(
  333. new WorkItemCallback(this.DoOnRezScriptQueue),
  334. new Object[0]);
  335. }
  336. }
  337. }
  338. }
  339. public Object DoOnRezScriptQueue(Object dummy)
  340. {
  341. if (m_InitialStartup)
  342. {
  343. m_InitialStartup = false;
  344. System.Threading.Thread.Sleep(15000);
  345. }
  346. Object o;
  347. lock (m_CompileQueue)
  348. {
  349. o = m_CompileQueue.Dequeue();
  350. if (o == null)
  351. {
  352. m_CurrentCompile = null;
  353. return null;
  354. }
  355. }
  356. DoOnRezScript(o);
  357. lock (m_CompileQueue)
  358. {
  359. if (m_CompileQueue.Count > 0)
  360. {
  361. m_CurrentCompile = m_ThreadPool.QueueWorkItem(
  362. new WorkItemCallback(this.DoOnRezScriptQueue),
  363. new Object[0]);
  364. }
  365. else
  366. {
  367. m_CurrentCompile = null;
  368. }
  369. }
  370. return null;
  371. }
  372. private bool DoOnRezScript(object parm)
  373. {
  374. Object[] p = (Object[])parm;
  375. uint localID = (uint)p[0];
  376. UUID itemID = (UUID)p[1];
  377. string script =(string)p[2];
  378. int startParam = (int)p[3];
  379. bool postOnRez = (bool)p[4];
  380. StateSource stateSource = (StateSource)p[5];
  381. // Get the asset ID of the script, so we can check if we
  382. // already have it.
  383. // We must look for the part outside the m_Scripts lock because GetSceneObjectPart later triggers the
  384. // m_parts lock on SOG. At the same time, a scene object that is being deleted will take the m_parts lock
  385. // and then later on try to take the m_scripts lock in this class when it calls OnRemoveScript()
  386. SceneObjectPart part = m_Scene.GetSceneObjectPart(localID);
  387. if (part == null)
  388. {
  389. Log.Error("[Script] SceneObjectPart unavailable. Script NOT started.");
  390. return false;
  391. }
  392. TaskInventoryItem item = part.Inventory.GetInventoryItem(itemID);
  393. if (item == null)
  394. return false;
  395. UUID assetID = item.AssetID;
  396. // m_log.DebugFormat("[XEngine] Compiling script {0} ({1})",
  397. // item.Name, itemID.ToString());
  398. ScenePresence presence = m_Scene.GetScenePresence(item.OwnerID);
  399. string assembly = "";
  400. CultureInfo USCulture = new CultureInfo("en-US");
  401. Thread.CurrentThread.CurrentCulture = USCulture;
  402. try
  403. {
  404. assembly = m_Compiler.PerformScriptCompile(script,
  405. assetID.ToString());
  406. }
  407. catch (Exception e)
  408. {
  409. if (presence != null && (!postOnRez))
  410. presence.ControllingClient.SendAgentAlertMessage("Script saved with errors, check debug window!", false);
  411. try
  412. {
  413. // DISPLAY ERROR INWORLD
  414. string text = "Error compiling script:\n" + e.Message.ToString();
  415. if (text.Length > 1000)
  416. text = text.Substring(0, 1000);
  417. World.SimChat(Utils.StringToBytes(text),
  418. ChatTypeEnum.DebugChannel, 2147483647,
  419. part.AbsolutePosition,
  420. part.Name, part.UUID, false);
  421. }
  422. catch (Exception e2) // LEGIT: User Scripting
  423. {
  424. m_log.Error("[XEngine]: "+
  425. "Error displaying error in-world: " +
  426. e2.ToString());
  427. m_log.Error("[XEngine]: " +
  428. "Errormessage: Error compiling script:\r\n" +
  429. e.Message.ToString());
  430. }
  431. return false;
  432. }
  433. lock (m_Scripts)
  434. {
  435. // Create the object record
  436. if ((!m_Scripts.ContainsKey(itemID)) ||
  437. (m_Scripts[itemID].AssetID != assetID))
  438. {
  439. UUID appDomain = assetID;
  440. if (part.ParentGroup.IsAttachment)
  441. appDomain = part.ParentGroup.RootPart.UUID;
  442. if (!m_AppDomains.ContainsKey(appDomain))
  443. {
  444. try
  445. {
  446. AppDomainSetup appSetup = new AppDomainSetup();
  447. // appSetup.ApplicationBase = Path.Combine(
  448. // "ScriptEngines",
  449. // m_Scene.RegionInfo.RegionID.ToString());
  450. Evidence baseEvidence = AppDomain.CurrentDomain.Evidence;
  451. Evidence evidence = new Evidence(baseEvidence);
  452. AppDomain sandbox =
  453. AppDomain.CreateDomain(
  454. m_Scene.RegionInfo.RegionID.ToString(),
  455. evidence, appSetup);
  456. /*
  457. PolicyLevel sandboxPolicy = PolicyLevel.CreateAppDomainLevel();
  458. AllMembershipCondition sandboxMembershipCondition = new AllMembershipCondition();
  459. PermissionSet sandboxPermissionSet = sandboxPolicy.GetNamedPermissionSet("Internet");
  460. PolicyStatement sandboxPolicyStatement = new PolicyStatement(sandboxPermissionSet);
  461. CodeGroup sandboxCodeGroup = new UnionCodeGroup(sandboxMembershipCondition, sandboxPolicyStatement);
  462. sandboxPolicy.RootCodeGroup = sandboxCodeGroup;
  463. sandbox.SetAppDomainPolicy(sandboxPolicy);
  464. */
  465. m_AppDomains[appDomain] = sandbox;
  466. m_AppDomains[appDomain].AssemblyResolve +=
  467. new ResolveEventHandler(
  468. AssemblyResolver.OnAssemblyResolve);
  469. m_DomainScripts[appDomain] = new List<UUID>();
  470. }
  471. catch (Exception e)
  472. {
  473. m_log.ErrorFormat("[XEngine] Exception creating app domain:\n {0}", e.ToString());
  474. return false;
  475. }
  476. }
  477. m_DomainScripts[appDomain].Add(itemID);
  478. ScriptInstance instance =
  479. new ScriptInstance(this, part,
  480. itemID, assetID, assembly,
  481. m_AppDomains[appDomain],
  482. part.ParentGroup.RootPart.Name,
  483. item.Name, startParam, postOnRez,
  484. stateSource, m_MaxScriptQueue);
  485. m_log.DebugFormat("[XEngine] Loaded script {0}.{1}",
  486. part.ParentGroup.RootPart.Name, item.Name);
  487. instance.AppDomain = appDomain;
  488. instance.LineMap = m_Compiler.LineMap();
  489. m_Scripts[itemID] = instance;
  490. }
  491. lock (m_PrimObjects)
  492. {
  493. if (!m_PrimObjects.ContainsKey(localID))
  494. m_PrimObjects[localID] = new List<UUID>();
  495. if (!m_PrimObjects[localID].Contains(itemID))
  496. m_PrimObjects[localID].Add(itemID);
  497. }
  498. if (!m_Assemblies.ContainsKey(assetID))
  499. m_Assemblies[assetID] = assembly;
  500. }
  501. return true;
  502. }
  503. public void OnRemoveScript(uint localID, UUID itemID)
  504. {
  505. lock (m_Scripts)
  506. {
  507. // Do we even have it?
  508. if (!m_Scripts.ContainsKey(itemID))
  509. return;
  510. IScriptInstance instance=m_Scripts[itemID];
  511. m_Scripts.Remove(itemID);
  512. instance.ClearQueue();
  513. instance.Stop(0);
  514. SceneObjectPart part =
  515. m_Scene.GetSceneObjectPart(localID);
  516. if (part != null)
  517. part.RemoveScriptEvents(itemID);
  518. lock (m_PrimObjects)
  519. {
  520. // Remove the script from it's prim
  521. if (m_PrimObjects.ContainsKey(localID))
  522. {
  523. // Remove inventory item record
  524. if (m_PrimObjects[localID].Contains(itemID))
  525. m_PrimObjects[localID].Remove(itemID);
  526. // If there are no more scripts, remove prim
  527. if (m_PrimObjects[localID].Count == 0)
  528. {
  529. m_PrimObjects.Remove(localID);
  530. }
  531. }
  532. }
  533. m_DomainScripts[instance.AppDomain].Remove(instance.ItemID);
  534. if (m_DomainScripts[instance.AppDomain].Count == 0)
  535. {
  536. m_DomainScripts.Remove(instance.AppDomain);
  537. UnloadAppDomain(instance.AppDomain);
  538. }
  539. instance.RemoveState();
  540. instance.DestroyScriptInstance();
  541. instance = null;
  542. CleanAssemblies();
  543. }
  544. }
  545. public void OnScriptReset(uint localID, UUID itemID)
  546. {
  547. ResetScript(itemID);
  548. }
  549. public void OnStartScript(uint localID, UUID itemID)
  550. {
  551. StartScript(itemID);
  552. }
  553. public void OnStopScript(uint localID, UUID itemID)
  554. {
  555. StopScript(itemID);
  556. }
  557. private void CleanAssemblies()
  558. {
  559. List<UUID> assetIDList = new List<UUID>(m_Assemblies.Keys);
  560. foreach (IScriptInstance i in m_Scripts.Values)
  561. {
  562. if (assetIDList.Contains(i.AssetID))
  563. assetIDList.Remove(i.AssetID);
  564. }
  565. foreach (UUID assetID in assetIDList)
  566. {
  567. // m_log.DebugFormat("[XEngine] Removing unreferenced assembly {0}", m_Assemblies[assetID]);
  568. try
  569. {
  570. if (File.Exists(m_Assemblies[assetID]))
  571. File.Delete(m_Assemblies[assetID]);
  572. if (File.Exists(m_Assemblies[assetID]+".state"))
  573. File.Delete(m_Assemblies[assetID]+".state");
  574. if (File.Exists(m_Assemblies[assetID]+".mdb"))
  575. File.Delete(m_Assemblies[assetID]+".mdb");
  576. }
  577. catch (Exception)
  578. {
  579. }
  580. m_Assemblies.Remove(assetID);
  581. }
  582. }
  583. private void UnloadAppDomain(UUID id)
  584. {
  585. if (m_AppDomains.ContainsKey(id))
  586. {
  587. AppDomain domain = m_AppDomains[id];
  588. m_AppDomains.Remove(id);
  589. AppDomain.Unload(domain);
  590. domain = null;
  591. // m_log.DebugFormat("[XEngine] Unloaded app domain {0}", id.ToString());
  592. }
  593. }
  594. //
  595. // Start processing
  596. //
  597. private void SetupEngine(int minThreads, int maxThreads,
  598. int idleTimeout, ThreadPriority threadPriority,
  599. int maxScriptQueue, int stackSize)
  600. {
  601. m_MaxScriptQueue = maxScriptQueue;
  602. STPStartInfo startInfo = new STPStartInfo();
  603. startInfo.IdleTimeout = idleTimeout;
  604. startInfo.MaxWorkerThreads = maxThreads;
  605. startInfo.MinWorkerThreads = minThreads;
  606. startInfo.ThreadPriority = threadPriority;
  607. startInfo.StackSize = stackSize;
  608. startInfo.StartSuspended = true;
  609. m_ThreadPool = new SmartThreadPool(startInfo);
  610. }
  611. //
  612. // Used by script instances to queue event handler jobs
  613. //
  614. public IScriptWorkItem QueueEventHandler(object parms)
  615. {
  616. return new XWorkItem(m_ThreadPool.QueueWorkItem(
  617. new WorkItemCallback(this.ProcessEventHandler),
  618. parms));
  619. }
  620. /// <summary>
  621. /// Process a previously posted script event.
  622. /// </summary>
  623. /// <param name="parms"></param>
  624. /// <returns></returns>
  625. private object ProcessEventHandler(object parms)
  626. {
  627. CultureInfo USCulture = new CultureInfo("en-US");
  628. Thread.CurrentThread.CurrentCulture = USCulture;
  629. IScriptInstance instance = (ScriptInstance) parms;
  630. //m_log.DebugFormat("[XENGINE]: Processing event for {0}", instance);
  631. return instance.EventProcessor();
  632. }
  633. /// <summary>
  634. /// Post event to an entire prim
  635. /// </summary>
  636. /// <param name="localID"></param>
  637. /// <param name="p"></param>
  638. /// <returns></returns>
  639. public bool PostObjectEvent(uint localID, EventParams p)
  640. {
  641. bool result = false;
  642. lock (m_PrimObjects)
  643. {
  644. if (!m_PrimObjects.ContainsKey(localID))
  645. return false;
  646. foreach (UUID itemID in m_PrimObjects[localID])
  647. {
  648. if (m_Scripts.ContainsKey(itemID))
  649. {
  650. IScriptInstance instance = m_Scripts[itemID];
  651. if (instance != null)
  652. {
  653. instance.PostEvent(p);
  654. result = true;
  655. }
  656. }
  657. }
  658. }
  659. return result;
  660. }
  661. /// <summary>
  662. /// Post an event to a single script
  663. /// </summary>
  664. /// <param name="itemID"></param>
  665. /// <param name="p"></param>
  666. /// <returns></returns>
  667. public bool PostScriptEvent(UUID itemID, EventParams p)
  668. {
  669. if (m_Scripts.ContainsKey(itemID))
  670. {
  671. IScriptInstance instance = m_Scripts[itemID];
  672. if (instance != null)
  673. instance.PostEvent(p);
  674. return true;
  675. }
  676. return false;
  677. }
  678. public Assembly OnAssemblyResolve(object sender,
  679. ResolveEventArgs args)
  680. {
  681. if (!(sender is System.AppDomain))
  682. return null;
  683. string[] pathList = new string[] {"bin", "ScriptEngines",
  684. Path.Combine("ScriptEngines",
  685. m_Scene.RegionInfo.RegionID.ToString())};
  686. string assemblyName = args.Name;
  687. if (assemblyName.IndexOf(",") != -1)
  688. assemblyName = args.Name.Substring(0, args.Name.IndexOf(","));
  689. foreach (string s in pathList)
  690. {
  691. string path = Path.Combine(Directory.GetCurrentDirectory(),
  692. Path.Combine(s, assemblyName))+".dll";
  693. if (File.Exists(path))
  694. return Assembly.LoadFrom(path);
  695. }
  696. return null;
  697. }
  698. private IScriptInstance GetInstance(UUID itemID)
  699. {
  700. IScriptInstance instance;
  701. lock (m_Scripts)
  702. {
  703. if (!m_Scripts.ContainsKey(itemID))
  704. return null;
  705. instance = m_Scripts[itemID];
  706. }
  707. return instance;
  708. }
  709. public void SetScriptState(UUID itemID, bool running)
  710. {
  711. IScriptInstance instance = GetInstance(itemID);
  712. if (instance != null)
  713. {
  714. if (running)
  715. instance.Start();
  716. else
  717. instance.Stop(100);
  718. }
  719. }
  720. public bool GetScriptState(UUID itemID)
  721. {
  722. IScriptInstance instance = GetInstance(itemID);
  723. if (instance != null)
  724. return instance.Running;
  725. return false;
  726. }
  727. public void ApiResetScript(UUID itemID)
  728. {
  729. IScriptInstance instance = GetInstance(itemID);
  730. if (instance != null)
  731. instance.ApiResetScript();
  732. }
  733. public void ResetScript(UUID itemID)
  734. {
  735. IScriptInstance instance = GetInstance(itemID);
  736. if (instance != null)
  737. instance.ResetScript();
  738. }
  739. public void StartScript(UUID itemID)
  740. {
  741. IScriptInstance instance = GetInstance(itemID);
  742. if (instance != null)
  743. instance.Start();
  744. }
  745. public void StopScript(UUID itemID)
  746. {
  747. IScriptInstance instance = GetInstance(itemID);
  748. if (instance != null)
  749. instance.Stop(0);
  750. }
  751. public DetectParams GetDetectParams(UUID itemID, int idx)
  752. {
  753. IScriptInstance instance = GetInstance(itemID);
  754. if (instance != null)
  755. return instance.GetDetectParams(idx);
  756. return null;
  757. }
  758. public void SetMinEventDelay(UUID itemID, double delay)
  759. {
  760. IScriptInstance instance = GetInstance(itemID);
  761. if (instance != null)
  762. instance.MinEventDelay = delay;
  763. }
  764. public UUID GetDetectID(UUID itemID, int idx)
  765. {
  766. IScriptInstance instance = GetInstance(itemID);
  767. if (instance != null)
  768. return instance.GetDetectID(idx);
  769. return UUID.Zero;
  770. }
  771. public void SetState(UUID itemID, string newState)
  772. {
  773. IScriptInstance instance = GetInstance(itemID);
  774. if (instance == null)
  775. return;
  776. instance.SetState(newState);
  777. }
  778. public string GetState(UUID itemID)
  779. {
  780. IScriptInstance instance = GetInstance(itemID);
  781. if (instance == null)
  782. return "default";
  783. return instance.State;
  784. }
  785. public int GetStartParameter(UUID itemID)
  786. {
  787. IScriptInstance instance = GetInstance(itemID);
  788. if (instance == null)
  789. return 0;
  790. return instance.StartParam;
  791. }
  792. public void OnShutdown()
  793. {
  794. List<IScriptInstance> instances = new List<IScriptInstance>();
  795. lock (m_Scripts)
  796. {
  797. foreach (IScriptInstance instance in m_Scripts.Values)
  798. instances.Add(instance);
  799. }
  800. foreach (IScriptInstance i in instances)
  801. {
  802. // Stop the script, even forcibly if needed. Then flag
  803. // it as shutting down and restore the previous run state
  804. // for serialization, so the scripts don't come back
  805. // dead after region restart
  806. //
  807. bool prevRunning = i.Running;
  808. i.Stop(50);
  809. i.ShuttingDown = true;
  810. i.Running = prevRunning;
  811. }
  812. DoBackup(new Object[] {0});
  813. }
  814. public IScriptApi GetApi(UUID itemID, string name)
  815. {
  816. IScriptInstance instance = GetInstance(itemID);
  817. if (instance == null)
  818. return null;
  819. return instance.GetApi(name);
  820. }
  821. public void OnGetScriptRunning(IClientAPI controllingClient, UUID objectID, UUID itemID)
  822. {
  823. IScriptInstance instance = GetInstance(itemID);
  824. if (instance == null)
  825. return;
  826. IEventQueue eq = World.RequestModuleInterface<IEventQueue>();
  827. if (eq == null)
  828. {
  829. controllingClient.SendScriptRunningReply(objectID, itemID,
  830. GetScriptState(itemID));
  831. }
  832. else
  833. {
  834. eq.Enqueue(EventQueueHelper.ScriptRunningReplyEvent(objectID, itemID, GetScriptState(itemID), true),
  835. controllingClient.AgentId);
  836. }
  837. }
  838. public string GetAssemblyName(UUID itemID)
  839. {
  840. IScriptInstance instance = GetInstance(itemID);
  841. if (instance == null)
  842. return "";
  843. return instance.GetAssemblyName();
  844. }
  845. public string GetXMLState(UUID itemID)
  846. {
  847. IScriptInstance instance = GetInstance(itemID);
  848. if (instance == null)
  849. return "";
  850. return instance.GetXMLState();
  851. }
  852. }
  853. }