XEngine.cs 45 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435
  1. using System;
  2. using System.IO;
  3. using System.Threading;
  4. using System.Collections;
  5. using System.Collections.Generic;
  6. using System.Security.Policy;
  7. using System.Reflection;
  8. using System.Xml;
  9. using libsecondlife;
  10. using log4net;
  11. using Nini.Config;
  12. using Amib.Threading;
  13. using OpenSim.Framework;
  14. using OpenSim.Region.Environment;
  15. using OpenSim.Region.Environment.Scenes;
  16. using OpenSim.Region.Environment.Interfaces;
  17. using OpenSim.Region.ScriptEngine.XEngine.Script;
  18. namespace OpenSim.Region.ScriptEngine.XEngine
  19. {
  20. public class XEngine : IRegionModule
  21. {
  22. private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
  23. private SmartThreadPool m_ThreadPool;
  24. private int m_MaxScriptQueue;
  25. private Scene m_Scene;
  26. private IConfig m_ScriptConfig;
  27. private Compiler m_Compiler;
  28. private EventManager m_EventManager;
  29. private int m_EventLimit;
  30. private bool m_KillTimedOutScripts;
  31. private static List<XEngine> m_ScriptEngines =
  32. new List<XEngine>();
  33. public AsyncCommandManager m_ASYNCLSLCommandManager;
  34. // Maps the local id to the script inventory items in it
  35. private Dictionary<uint, List<LLUUID> > m_PrimObjects =
  36. new Dictionary<uint, List<LLUUID> >();
  37. // Maps the LLUUID above to the script instance
  38. private Dictionary<LLUUID, XScriptInstance> m_Scripts =
  39. new Dictionary<LLUUID, XScriptInstance>();
  40. // Maps the asset ID to the assembly
  41. private Dictionary<LLUUID, string> m_Assemblies =
  42. new Dictionary<LLUUID, string>();
  43. // This will list AppDomains by script asset
  44. private Dictionary<LLUUID, AppDomain> m_AppDomains =
  45. new Dictionary<LLUUID, AppDomain>();
  46. // List the scripts running in each appdomain
  47. private Dictionary<LLUUID, List<LLUUID> > m_DomainScripts =
  48. new Dictionary<LLUUID, List<LLUUID> >();
  49. public string ScriptEngineName
  50. {
  51. get { return "XEngine"; }
  52. }
  53. public Scene World
  54. {
  55. get { return m_Scene; }
  56. }
  57. public ILog Log
  58. {
  59. get { return m_log; }
  60. }
  61. public static List<XEngine> ScriptEngines
  62. {
  63. get { return m_ScriptEngines; }
  64. }
  65. private struct RezScriptParms
  66. {
  67. uint LocalID;
  68. LLUUID ItemID;
  69. string Script;
  70. }
  71. public IConfig ScriptConfigSource
  72. {
  73. get { return m_ScriptConfig; }
  74. }
  75. //
  76. // IRegionModule functions
  77. //
  78. public void Initialise(Scene scene, IConfigSource configSource)
  79. {
  80. AppDomain.CurrentDomain.AssemblyResolve +=
  81. OnAssemblyResolve;
  82. m_log.InfoFormat("[XEngine] Initializing scripts in region {0}",
  83. scene.RegionInfo.RegionName);
  84. m_Scene=scene;
  85. m_ScriptConfig = configSource.Configs["XEngine"];
  86. if(m_ScriptConfig == null)
  87. {
  88. m_log.ErrorFormat("[XEngine] No script configuration found. Scripts disabled");
  89. return;
  90. }
  91. int minThreads = m_ScriptConfig.GetInt("MinThreads", 2);
  92. int maxThreads = m_ScriptConfig.GetInt("MaxThreads", 2);
  93. int idleTimeout = m_ScriptConfig.GetInt("IdleTimeout", 60);
  94. string priority = m_ScriptConfig.GetString("Priority", "BelowNormal");
  95. int maxScriptQueue = m_ScriptConfig.GetInt("MaxScriptEventQueue",300);
  96. int stackSize = m_ScriptConfig.GetInt("ThreadStackSize", 262144);
  97. int sleepTime = m_ScriptConfig.GetInt("MaintenanceInterval",
  98. 10)*1000;
  99. m_EventLimit = m_ScriptConfig.GetInt("EventLimit", 30);
  100. m_KillTimedOutScripts = m_ScriptConfig.GetBoolean(
  101. "KillTimedOutScripts", false);
  102. int saveTime = m_ScriptConfig.GetInt("SaveInterval", 300)*1000;
  103. ThreadPriority prio = ThreadPriority.BelowNormal;
  104. switch(priority)
  105. {
  106. case "Lowest":
  107. prio=ThreadPriority.Lowest;
  108. break;
  109. case "BelowNormal":
  110. prio=ThreadPriority.BelowNormal;
  111. break;
  112. case "Normal":
  113. prio=ThreadPriority.Normal;
  114. break;
  115. case "AboveNormal":
  116. prio=ThreadPriority.AboveNormal;
  117. break;
  118. case "Highest":
  119. prio=ThreadPriority.Highest;
  120. break;
  121. default:
  122. m_log.ErrorFormat("[XEngine] Invalid thread priority: '"+
  123. priority+"'. Assuming BelowNormal");
  124. break;
  125. }
  126. lock(m_ScriptEngines)
  127. {
  128. m_ScriptEngines.Add(this);
  129. }
  130. m_EventManager = new EventManager(this);
  131. m_ASYNCLSLCommandManager = new AsyncCommandManager(this);
  132. StartEngine(minThreads, maxThreads, idleTimeout, prio,
  133. maxScriptQueue, stackSize);
  134. m_Compiler = new Compiler(this);
  135. m_Scene.EventManager.OnRezScript += OnRezScript;
  136. m_Scene.EventManager.OnRemoveScript += OnRemoveScript;
  137. m_Scene.EventManager.OnScriptReset += OnScriptReset;
  138. if(sleepTime > 0)
  139. {
  140. m_ThreadPool.QueueWorkItem(new WorkItemCallback(
  141. this.DoMaintenance), new Object[]
  142. { sleepTime });
  143. }
  144. if(saveTime > 0)
  145. {
  146. m_ThreadPool.QueueWorkItem(new WorkItemCallback(
  147. this.DoBackup), new Object[] { saveTime });
  148. }
  149. }
  150. public void PostInitialise()
  151. {
  152. m_ThreadPool.Start();
  153. }
  154. public void Close()
  155. {
  156. lock(m_ScriptEngines)
  157. {
  158. if(m_ScriptEngines.Contains(this))
  159. m_ScriptEngines.Remove(this);
  160. }
  161. }
  162. public object DoBackup(object o)
  163. {
  164. Object[] p = (Object[])o;
  165. int saveTime = (int)p[0];
  166. System.Threading.Thread.Sleep(saveTime);
  167. // m_log.Debug("[XEngine] Backing up script states");
  168. List<XScriptInstance> instances = new List<XScriptInstance>();
  169. lock(m_Scripts)
  170. {
  171. foreach (XScriptInstance instance in m_Scripts.Values)
  172. instances.Add(instance);
  173. }
  174. foreach (XScriptInstance i in instances)
  175. {
  176. string assembly = String.Empty;
  177. lock(m_Scripts)
  178. {
  179. if(!m_Assemblies.ContainsKey(i.AssetID))
  180. continue;
  181. assembly = m_Assemblies[i.AssetID];
  182. }
  183. i.SaveState(assembly);
  184. }
  185. instances.Clear();
  186. m_ThreadPool.QueueWorkItem(new WorkItemCallback(
  187. this.DoBackup), new Object[] { saveTime });
  188. return 0;
  189. }
  190. public object DoMaintenance(object p)
  191. {
  192. object[] parms = (object[])p;
  193. int sleepTime = (int)parms[0];
  194. foreach (XScriptInstance inst in m_Scripts.Values)
  195. {
  196. if(inst.EventTime() > m_EventLimit)
  197. {
  198. inst.Stop(100);
  199. if(!m_KillTimedOutScripts)
  200. inst.Start();
  201. }
  202. }
  203. System.Threading.Thread.Sleep(sleepTime);
  204. m_ThreadPool.QueueWorkItem(new WorkItemCallback(
  205. this.DoMaintenance), new Object[]
  206. { sleepTime });
  207. return 0;
  208. }
  209. public string Name
  210. {
  211. get { return "XEngine"; }
  212. }
  213. public bool IsSharedModule
  214. {
  215. get { return false; }
  216. }
  217. //
  218. // XEngine functions
  219. //
  220. public int MaxScriptQueue
  221. {
  222. get { return m_MaxScriptQueue; }
  223. }
  224. //
  225. // Hooks
  226. //
  227. public void OnRezScript(uint localID, LLUUID itemID, string script)
  228. {
  229. m_ThreadPool.QueueWorkItem(new WorkItemCallback(
  230. this.DoOnRezScript), new Object[]
  231. { localID, itemID, script});
  232. }
  233. private object DoOnRezScript(object parm)
  234. {
  235. Object[] p = (Object[])parm;
  236. uint localID = (uint)p[0];
  237. LLUUID itemID = (LLUUID)p[1];
  238. string script =(string)p[2];
  239. // Get the asset ID of the script, so we can check if we
  240. // already have it.
  241. SceneObjectPart part = m_Scene.GetSceneObjectPart(localID);
  242. if(part == null)
  243. return false;
  244. TaskInventoryItem item = part.GetInventoryItem(itemID);
  245. if(item == null)
  246. return false;
  247. LLUUID assetID=item.AssetID;
  248. // m_log.DebugFormat("[XEngine] Compiling script {0} ({1})",
  249. // item.Name, itemID.ToString());
  250. string assembly="";
  251. try
  252. {
  253. assembly=m_Compiler.PerformScriptCompile(script,
  254. assetID.ToString());
  255. m_log.DebugFormat("[XEngine] Loaded script {0}.{1}",
  256. part.ParentGroup.RootPart.Name, item.Name);
  257. }
  258. catch (Exception e)
  259. {
  260. try
  261. {
  262. // DISPLAY ERROR INWORLD
  263. string text = "Error compiling script:\r\n" + e.Message.ToString();
  264. if (text.Length > 1400)
  265. text = text.Substring(0, 1400);
  266. World.SimChat(Helpers.StringToField(text),
  267. ChatTypeEnum.DebugChannel, 2147483647,
  268. part.AbsolutePosition,
  269. part.Name, part.UUID, false);
  270. }
  271. catch (Exception e2) // LEGIT: User Scripting
  272. {
  273. m_log.Error("[XEngine]: "+
  274. "Error displaying error in-world: " +
  275. e2.ToString());
  276. m_log.Error("[XEngine]: " +
  277. "Errormessage: Error compiling script:\r\n" +
  278. e.Message.ToString());
  279. }
  280. return false;
  281. }
  282. lock(m_Scripts)
  283. {
  284. // Create the object record
  285. if(!m_PrimObjects.ContainsKey(localID))
  286. m_PrimObjects[localID] = new List<LLUUID>();
  287. if(!m_PrimObjects[localID].Contains(itemID))
  288. m_PrimObjects[localID].Add(itemID);
  289. if(!m_Assemblies.ContainsKey(assetID))
  290. m_Assemblies[assetID] = assembly;
  291. if((!m_Scripts.ContainsKey(itemID)) ||
  292. (m_Scripts[itemID].AssetID != assetID))
  293. {
  294. LLUUID appDomain=assetID;
  295. if(part.ParentGroup.RootPart.m_IsAttachment)
  296. appDomain=part.ParentGroup.RootPart.UUID;
  297. if(!m_AppDomains.ContainsKey(appDomain))
  298. {
  299. try
  300. {
  301. AppDomainSetup appSetup = new AppDomainSetup();
  302. // appSetup.ApplicationBase = Path.Combine(
  303. // "ScriptEngines",
  304. // m_Scene.RegionInfo.RegionID.ToString());
  305. Evidence baseEvidence =
  306. AppDomain.CurrentDomain.Evidence;
  307. Evidence evidence = new Evidence(baseEvidence);
  308. m_AppDomains[appDomain] =
  309. AppDomain.CreateDomain(
  310. m_Scene.RegionInfo.RegionID.ToString(),
  311. evidence, appSetup);
  312. m_AppDomains[appDomain].AssemblyResolve +=
  313. new ResolveEventHandler(
  314. AssemblyResolver.OnAssemblyResolve);
  315. m_DomainScripts[appDomain] = new List<LLUUID>();
  316. }
  317. catch (Exception e)
  318. {
  319. m_log.Error("[XEngine] Exception creating app domain:\n"+e.ToString());
  320. return false;
  321. }
  322. }
  323. m_DomainScripts[appDomain].Add(itemID);
  324. XScriptInstance instance = new XScriptInstance(this,localID,
  325. part.UUID, itemID, assetID, assembly,
  326. m_AppDomains[appDomain]);
  327. instance.AppDomain = appDomain;
  328. m_Scripts[itemID] = instance;
  329. }
  330. }
  331. return true;
  332. }
  333. public void OnRemoveScript(uint localID, LLUUID itemID)
  334. {
  335. lock(m_Scripts)
  336. {
  337. // Do we even have it?
  338. if(!m_Scripts.ContainsKey(itemID))
  339. return;
  340. m_ASYNCLSLCommandManager.RemoveScript(localID, itemID);
  341. XScriptInstance instance=m_Scripts[itemID];
  342. m_Scripts.Remove(itemID);
  343. instance.ClearQueue();
  344. instance.Stop(0);
  345. SceneObjectPart part =
  346. m_Scene.GetSceneObjectPart(localID);
  347. if(part != null)
  348. part.RemoveScriptEvents(itemID);
  349. // Remove the script from it's prim
  350. if(m_PrimObjects.ContainsKey(localID))
  351. {
  352. // Remove inventory item record
  353. if(m_PrimObjects[localID].Contains(itemID))
  354. m_PrimObjects[localID].Remove(itemID);
  355. // If there are no more scripts, remove prim
  356. if(m_PrimObjects[localID].Count == 0)
  357. {
  358. m_PrimObjects.Remove(localID);
  359. }
  360. }
  361. m_DomainScripts[instance.AppDomain].Remove(instance.ItemID);
  362. if(m_DomainScripts[instance.AppDomain].Count == 0)
  363. {
  364. m_DomainScripts.Remove(instance.AppDomain);
  365. UnloadAppDomain(instance.AppDomain);
  366. }
  367. instance = null;
  368. CleanAssemblies();
  369. }
  370. }
  371. public void OnScriptReset(uint localID, LLUUID itemID)
  372. {
  373. ResetScript(itemID);
  374. }
  375. private void CleanAssemblies()
  376. {
  377. List<LLUUID> assetIDList = new List<LLUUID>(m_Assemblies.Keys);
  378. foreach (XScriptInstance i in m_Scripts.Values)
  379. {
  380. if(assetIDList.Contains(i.AssetID))
  381. assetIDList.Remove(i.AssetID);
  382. }
  383. foreach (LLUUID assetID in assetIDList)
  384. {
  385. // m_log.DebugFormat("[XEngine] Removing unreferenced assembly {0}", m_Assemblies[assetID]);
  386. try
  387. {
  388. if(File.Exists(m_Assemblies[assetID]))
  389. File.Delete(m_Assemblies[assetID]);
  390. if(File.Exists(m_Assemblies[assetID]+".state"))
  391. File.Delete(m_Assemblies[assetID]+".state");
  392. if(File.Exists(m_Assemblies[assetID]+".mdb"))
  393. File.Delete(m_Assemblies[assetID]+".mdb");
  394. }
  395. catch (Exception e)
  396. {
  397. }
  398. m_Assemblies.Remove(assetID);
  399. }
  400. }
  401. private void UnloadAppDomain(LLUUID id)
  402. {
  403. if(m_AppDomains.ContainsKey(id))
  404. {
  405. AppDomain domain=m_AppDomains[id];
  406. m_AppDomains.Remove(id);
  407. AppDomain.Unload(domain);
  408. domain = null;
  409. // m_log.DebugFormat("[XEngine] Unloaded app domain {0}", id.ToString());
  410. }
  411. }
  412. //
  413. // Start processing
  414. //
  415. private void StartEngine(int minThreads, int maxThreads,
  416. int idleTimeout, ThreadPriority threadPriority,
  417. int maxScriptQueue, int stackSize)
  418. {
  419. m_MaxScriptQueue=maxScriptQueue;
  420. STPStartInfo startInfo = new STPStartInfo();
  421. startInfo.IdleTimeout = idleTimeout;
  422. startInfo.MaxWorkerThreads = maxThreads;
  423. startInfo.MinWorkerThreads = minThreads;
  424. startInfo.ThreadPriority = threadPriority;
  425. startInfo.StackSize = stackSize;
  426. startInfo.StartSuspended = true;
  427. m_ThreadPool = new SmartThreadPool(startInfo);
  428. }
  429. //
  430. // Used by script instances to queue event handler jobs
  431. //
  432. public IWorkItemResult QueueEventHandler(object parms)
  433. {
  434. return m_ThreadPool.QueueWorkItem(new WorkItemCallback(
  435. this.ProcessEventHandler), parms);
  436. }
  437. //
  438. // The main script engine worker
  439. //
  440. private object ProcessEventHandler(object parms)
  441. {
  442. XScriptInstance instance=(XScriptInstance)parms;
  443. return instance.EventProcessor();
  444. }
  445. //
  446. // Post event to an entire prim
  447. //
  448. public bool PostObjectEvent(uint localID, XEventParams p)
  449. {
  450. bool result = false;
  451. if(!m_PrimObjects.ContainsKey(localID))
  452. return false;
  453. foreach (LLUUID itemID in m_PrimObjects[localID])
  454. {
  455. if(m_Scripts.ContainsKey(itemID))
  456. {
  457. XScriptInstance instance = m_Scripts[itemID];
  458. if(instance != null)
  459. {
  460. instance.PostEvent(p);
  461. result = true;
  462. }
  463. }
  464. }
  465. return result;
  466. }
  467. //
  468. // Post an event to a single script
  469. //
  470. public bool PostScriptEvent(LLUUID itemID, XEventParams p)
  471. {
  472. if(m_Scripts.ContainsKey(itemID))
  473. {
  474. XScriptInstance instance = m_Scripts[itemID];
  475. if(instance != null)
  476. instance.PostEvent(p);
  477. return true;
  478. }
  479. return false;
  480. }
  481. public Assembly OnAssemblyResolve(object sender,
  482. ResolveEventArgs args)
  483. {
  484. if(!(sender is System.AppDomain))
  485. return null;
  486. string[] pathList=new string[] {"bin", "ScriptEngines",
  487. Path.Combine("ScriptEngines",
  488. m_Scene.RegionInfo.RegionID.ToString())};
  489. string assemblyName = args.Name;
  490. if(assemblyName.IndexOf(",") != -1)
  491. assemblyName=args.Name.Substring(0, args.Name.IndexOf(","));
  492. foreach (string s in pathList)
  493. {
  494. string path=Path.Combine(Directory.GetCurrentDirectory(),
  495. Path.Combine(s, assemblyName))+".dll";
  496. if(File.Exists(path))
  497. return Assembly.LoadFrom(path);
  498. }
  499. return null;
  500. }
  501. private XScriptInstance GetInstance(LLUUID itemID)
  502. {
  503. XScriptInstance instance;
  504. lock(m_Scripts)
  505. {
  506. if(!m_Scripts.ContainsKey(itemID))
  507. return null;
  508. instance = m_Scripts[itemID];
  509. }
  510. return instance;
  511. }
  512. public void SetScriptState(LLUUID itemID, bool running)
  513. {
  514. XScriptInstance instance = GetInstance(itemID);
  515. if(instance != null)
  516. {
  517. if(running)
  518. instance.Start();
  519. else
  520. instance.Stop(500);
  521. }
  522. }
  523. public bool GetScriptState(LLUUID itemID)
  524. {
  525. XScriptInstance instance = GetInstance(itemID);
  526. if(instance != null)
  527. return instance.Running;
  528. return false;
  529. }
  530. public void ResetScript(LLUUID itemID)
  531. {
  532. XScriptInstance instance = GetInstance(itemID);
  533. if(instance != null)
  534. instance.ResetScript();
  535. }
  536. public XDetectParams GetDetectParams(LLUUID itemID, int idx)
  537. {
  538. XScriptInstance instance = GetInstance(itemID);
  539. if(instance != null)
  540. return instance.GetDetectParams(idx);
  541. return new XDetectParams();
  542. }
  543. public LLUUID GetDetectID(LLUUID itemID, int idx)
  544. {
  545. XScriptInstance instance = GetInstance(itemID);
  546. if(instance != null)
  547. return instance.GetDetectID(idx);
  548. return LLUUID.Zero;
  549. }
  550. }
  551. public struct XDetectParams
  552. {
  553. public LLUUID Key;
  554. public LSL_Types.Vector3 OffsetPos;
  555. }
  556. public class XEventParams
  557. {
  558. public XEventParams(string eventName, Object[] eventParams, XDetectParams[] detectParams)
  559. {
  560. EventName=eventName;
  561. Params=eventParams;
  562. DetectParams=detectParams;
  563. }
  564. public string EventName;
  565. public Object[] Params;
  566. public XDetectParams[] DetectParams;
  567. }
  568. public class XScriptInstance
  569. {
  570. private XEngine m_Engine;
  571. private IWorkItemResult m_CurrentResult=null;
  572. private Queue m_EventQueue=new Queue(32);
  573. private bool m_RunEvents=false;
  574. private LLUUID m_ItemID;
  575. private uint m_LocalID;
  576. private LLUUID m_ObjectID;
  577. private LLUUID m_AssetID;
  578. private IScript m_Script;
  579. private LSL_ScriptCommands m_LSLCommands;
  580. private OSSL_ScriptCommands m_OSSLCommands;
  581. private Executor m_Executor;
  582. private LLUUID m_AppDomain;
  583. private XDetectParams[] m_DetectParams;
  584. private bool m_TimerQueued;
  585. private DateTime m_EventStart;
  586. private bool m_InEvent;
  587. // Script state
  588. private string m_State="default";
  589. public Object[] PluginData = new Object[0];
  590. public bool Running
  591. {
  592. get { return m_RunEvents; }
  593. }
  594. public string State
  595. {
  596. get { return m_State; }
  597. set { m_State = value; }
  598. }
  599. public XEngine Engine
  600. {
  601. get { return m_Engine; }
  602. }
  603. public LLUUID AppDomain
  604. {
  605. get { return m_AppDomain; }
  606. set { m_AppDomain = value; }
  607. }
  608. public LLUUID ItemID
  609. {
  610. get { return m_ItemID; }
  611. }
  612. public LLUUID ObjectID
  613. {
  614. get { return m_ObjectID; }
  615. }
  616. public uint LocalID
  617. {
  618. get { return m_LocalID; }
  619. }
  620. public LLUUID AssetID
  621. {
  622. get { return m_AssetID; }
  623. }
  624. public Queue EventQueue
  625. {
  626. get { return m_EventQueue; }
  627. }
  628. public void ClearQueue()
  629. {
  630. m_TimerQueued = false;
  631. m_EventQueue.Clear();
  632. }
  633. public XScriptInstance(XEngine engine, uint localID, LLUUID objectID,
  634. LLUUID itemID, LLUUID assetID, string assembly, AppDomain dom)
  635. {
  636. m_Engine=engine;
  637. m_LocalID = localID;
  638. m_ObjectID = objectID;
  639. m_ItemID = itemID;
  640. m_AssetID = assetID;
  641. SceneObjectPart part=engine.World.GetSceneObjectPart(localID);
  642. if(part == null)
  643. {
  644. engine.Log.Error("[XEngine] SceneObjectPart unavailable. Script NOT started.");
  645. return;
  646. }
  647. m_LSLCommands = new LSL_ScriptCommands(engine, this, part, localID,
  648. itemID);
  649. m_OSSLCommands = new OSSL_ScriptCommands(engine, this, part,
  650. localID, itemID);
  651. try
  652. {
  653. m_Script = (IScript)dom.CreateInstanceAndUnwrap(
  654. Path.GetFileNameWithoutExtension(assembly),
  655. "SecondLife.Script");
  656. }
  657. catch (Exception e)
  658. {
  659. m_Engine.Log.ErrorFormat("[XEngine] Error loading assembly {0}\n"+e.ToString(), assembly);
  660. }
  661. try
  662. {
  663. m_Script.Start(m_LSLCommands, m_OSSLCommands);
  664. m_Executor = new Executor(m_Script);
  665. // m_Engine.Log.Debug("[XEngine] Script instance created");
  666. part.SetScriptEvents(m_ItemID,
  667. (int)m_Executor.GetStateEventFlags());
  668. }
  669. catch (Exception e)
  670. {
  671. m_Engine.Log.Error("Error loading script instance\n"+e.ToString());
  672. }
  673. string savedState = assembly+".state";
  674. if(File.Exists(savedState))
  675. {
  676. string xml = String.Empty;
  677. try
  678. {
  679. FileInfo fi = new FileInfo(savedState);
  680. int size=(int)fi.Length;
  681. if(size < 130000)
  682. {
  683. using (FileStream fs = File.Open(savedState,
  684. FileMode.Open, FileAccess.Read, FileShare.None))
  685. {
  686. System.Text.ASCIIEncoding enc =
  687. new System.Text.ASCIIEncoding();
  688. Byte[] data=new Byte[size];
  689. fs.Read(data, 0, size);
  690. xml=enc.GetString(data);
  691. ScriptSerializer.Deserialize(xml, this);
  692. m_Engine.m_ASYNCLSLCommandManager.CreateFromData(
  693. m_LocalID, m_ItemID, m_ObjectID,
  694. PluginData);
  695. }
  696. }
  697. else
  698. {
  699. m_Engine.Log.Error("Unable to load script state: Memory limit exceeded");
  700. PostEvent(new XEventParams("state_entry",
  701. new Object[0], new XDetectParams[0]));
  702. }
  703. }
  704. catch (Exception e)
  705. {
  706. m_Engine.Log.ErrorFormat("Unable to load script state from xml: {0}\n"+e.ToString(), xml);
  707. PostEvent(new XEventParams("state_entry",
  708. new Object[0], new XDetectParams[0]));
  709. }
  710. }
  711. else
  712. {
  713. PostEvent(new XEventParams("state_entry",
  714. new Object[0], new XDetectParams[0]));
  715. }
  716. Start();
  717. }
  718. public void VarDump(Dictionary<string, object> vars)
  719. {
  720. Console.WriteLine("Variable dump for script {0}", m_ItemID.ToString());
  721. foreach (KeyValuePair<string, object> v in vars)
  722. {
  723. Console.WriteLine("Variable: {0} = '{1}'", v. Key,
  724. v.Value.ToString());
  725. }
  726. }
  727. public void Start()
  728. {
  729. lock(m_EventQueue)
  730. {
  731. if(Running)
  732. return;
  733. m_RunEvents=true;
  734. if(m_EventQueue.Count > 0)
  735. {
  736. if(m_CurrentResult == null)
  737. m_CurrentResult=m_Engine.QueueEventHandler(this);
  738. }
  739. }
  740. }
  741. public bool Stop(int timeout)
  742. {
  743. IWorkItemResult result;
  744. lock(m_EventQueue)
  745. {
  746. if(!Running)
  747. return true;
  748. if(m_CurrentResult == null)
  749. {
  750. m_RunEvents=false;
  751. return true;
  752. }
  753. if(m_CurrentResult.Cancel())
  754. {
  755. m_CurrentResult=null;
  756. m_RunEvents=false;
  757. return true;
  758. }
  759. result=m_CurrentResult;
  760. m_RunEvents=false;
  761. }
  762. if(SmartThreadPool.WaitAll(new IWorkItemResult[] {result}, new TimeSpan((long)timeout*100000), false))
  763. {
  764. return true;
  765. }
  766. lock(m_EventQueue)
  767. {
  768. if(m_CurrentResult != null)
  769. m_CurrentResult.Abort();
  770. else
  771. return true;
  772. }
  773. return true;
  774. }
  775. public void SetState(string state)
  776. {
  777. PostEvent(new XEventParams("state_exit", new Object[0],
  778. new XDetectParams[0]));
  779. PostEvent(new XEventParams("state", new Object[] { state },
  780. new XDetectParams[0]));
  781. PostEvent(new XEventParams("state_entry", new Object[0],
  782. new XDetectParams[0]));
  783. }
  784. public void PostEvent(XEventParams data)
  785. {
  786. lock(m_EventQueue)
  787. {
  788. if(m_EventQueue.Count >= m_Engine.MaxScriptQueue)
  789. return;
  790. m_EventQueue.Enqueue(data);
  791. if(data.EventName == "timer")
  792. {
  793. if(m_TimerQueued)
  794. return;
  795. m_TimerQueued = true;
  796. }
  797. if(!m_RunEvents)
  798. return;
  799. if(m_CurrentResult == null)
  800. {
  801. m_CurrentResult=m_Engine.QueueEventHandler(this);
  802. }
  803. }
  804. }
  805. public object EventProcessor()
  806. {
  807. XEventParams data=null;
  808. lock(m_EventQueue)
  809. {
  810. data=(XEventParams)m_EventQueue.Dequeue();
  811. if(data == null) // Shouldn't happen
  812. {
  813. m_CurrentResult=null;
  814. return 0;
  815. }
  816. if(data.EventName == "timer")
  817. m_TimerQueued = false;
  818. }
  819. m_DetectParams=data.DetectParams;
  820. if(data.EventName == "state") // Hardcoded state change
  821. {
  822. m_State=data.Params[0].ToString();
  823. m_Engine.m_ASYNCLSLCommandManager.RemoveScript(
  824. m_LocalID, m_ItemID);
  825. SceneObjectPart part=m_Engine.World.GetSceneObjectPart(
  826. m_LocalID);
  827. if(part != null)
  828. {
  829. part.SetScriptEvents(m_ItemID,
  830. (int)m_Executor.GetStateEventFlags());
  831. }
  832. }
  833. else
  834. {
  835. // m_Engine.Log.DebugFormat("[XEngine] Processed event {0}", data.EventName);
  836. SceneObjectPart part=m_Engine.World.GetSceneObjectPart(
  837. m_LocalID);
  838. try
  839. {
  840. m_EventStart = DateTime.Now;
  841. m_InEvent = true;
  842. m_Executor.ExecuteEvent(data.EventName, data.Params);
  843. m_InEvent = false;
  844. }
  845. catch (Exception e)
  846. {
  847. m_InEvent = false;
  848. if(e is System.Threading.ThreadAbortException)
  849. {
  850. lock(m_EventQueue)
  851. {
  852. if((m_EventQueue.Count > 0) && m_RunEvents)
  853. {
  854. m_CurrentResult=m_Engine.QueueEventHandler(this);
  855. }
  856. else
  857. {
  858. m_CurrentResult=null;
  859. }
  860. }
  861. m_DetectParams=null;
  862. return 0;
  863. }
  864. try
  865. {
  866. // DISPLAY ERROR INWORLD
  867. string text = "Runtime error:\n" + e.ToString();
  868. if (text.Length > 1400)
  869. text = text.Substring(0, 1400);
  870. m_Engine.World.SimChat(Helpers.StringToField(text),
  871. ChatTypeEnum.DebugChannel, 2147483647,
  872. part.AbsolutePosition,
  873. part.Name, part.UUID, false);
  874. }
  875. catch (Exception e2) // LEGIT: User Scripting
  876. {
  877. m_Engine.Log.Error("[XEngine]: "+
  878. "Error displaying error in-world: " +
  879. e2.ToString());
  880. m_Engine.Log.Error("[XEngine]: " +
  881. "Errormessage: Error compiling script:\r\n" +
  882. e.ToString());
  883. }
  884. }
  885. }
  886. lock(m_EventQueue)
  887. {
  888. if((m_EventQueue.Count > 0) && m_RunEvents)
  889. {
  890. m_CurrentResult=m_Engine.QueueEventHandler(this);
  891. }
  892. else
  893. {
  894. m_CurrentResult=null;
  895. }
  896. }
  897. m_DetectParams=null;
  898. return 0;
  899. }
  900. public int EventTime()
  901. {
  902. if(!m_InEvent)
  903. return 0;
  904. return (DateTime.Now - m_EventStart).Seconds;
  905. }
  906. public void ResetScript()
  907. {
  908. Stop(0);
  909. m_Engine.m_ASYNCLSLCommandManager.RemoveScript(m_LocalID, m_ItemID);
  910. m_EventQueue.Clear();
  911. m_Script.ResetVars();
  912. m_State = "default";
  913. Start();
  914. PostEvent(new XEventParams("state_entry",
  915. new Object[0], new XDetectParams[0]));
  916. }
  917. public Dictionary<string, object> GetVars()
  918. {
  919. return m_Script.GetVars();
  920. }
  921. public void SetVars(Dictionary<string, object> vars)
  922. {
  923. m_Script.SetVars(vars);
  924. }
  925. public XDetectParams GetDetectParams(int idx)
  926. {
  927. if(idx < 0 || idx >= m_DetectParams.Length)
  928. return new XDetectParams();
  929. return m_DetectParams[idx];
  930. }
  931. public LLUUID GetDetectID(int idx)
  932. {
  933. if(idx < 0 || idx >= m_DetectParams.Length)
  934. return LLUUID.Zero;
  935. return m_DetectParams[idx].Key;
  936. }
  937. public void SaveState(string assembly)
  938. {
  939. PluginData =
  940. m_Engine.m_ASYNCLSLCommandManager.GetSerializationData(
  941. m_ItemID);
  942. string xml=ScriptSerializer.Serialize(this);
  943. try
  944. {
  945. FileStream fs = File.Create(assembly+".state");
  946. System.Text.ASCIIEncoding enc = new System.Text.ASCIIEncoding();
  947. Byte[] buf=enc.GetBytes(xml);
  948. fs.Write(buf, 0, buf.Length);
  949. fs.Close();
  950. }
  951. catch(Exception)
  952. {
  953. return;
  954. }
  955. }
  956. }
  957. public class ScriptSerializer
  958. {
  959. public static string Serialize(XScriptInstance instance)
  960. {
  961. instance.Stop(50);
  962. XmlDocument xmldoc = new XmlDocument();
  963. XmlNode xmlnode = xmldoc.CreateNode(XmlNodeType.XmlDeclaration,
  964. "", "");
  965. xmldoc.AppendChild(xmlnode);
  966. XmlElement rootElement = xmldoc.CreateElement("", "ScriptState",
  967. "");
  968. xmldoc.AppendChild(rootElement);
  969. XmlElement state = xmldoc.CreateElement("", "State", "");
  970. state.AppendChild(xmldoc.CreateTextNode(instance.State));
  971. rootElement.AppendChild(state);
  972. Dictionary<string, Object> vars = instance.GetVars();
  973. XmlElement variables = xmldoc.CreateElement("", "Variables", "");
  974. foreach (KeyValuePair<string, Object> var in vars)
  975. WriteTypedValue(xmldoc, variables, "Variable", var.Key,
  976. var.Value);
  977. rootElement.AppendChild(variables);
  978. XmlElement queue = xmldoc.CreateElement("", "Queue", "");
  979. int count = instance.EventQueue.Count;
  980. while(count > 0)
  981. {
  982. XEventParams ep = (XEventParams)instance.EventQueue.Dequeue();
  983. instance.EventQueue.Enqueue(ep);
  984. count--;
  985. XmlElement item = xmldoc.CreateElement("", "Item", "");
  986. XmlAttribute itemEvent = xmldoc.CreateAttribute("", "event",
  987. "");
  988. itemEvent.Value=ep.EventName;
  989. item.Attributes.Append(itemEvent);
  990. XmlElement parms = xmldoc.CreateElement("", "Params", "");
  991. foreach (Object o in ep.Params)
  992. WriteTypedValue(xmldoc, parms, "Param", String.Empty, o);
  993. item.AppendChild(parms);
  994. XmlElement detect = xmldoc.CreateElement("", "Detected", "");
  995. foreach (XDetectParams det in ep.DetectParams)
  996. {
  997. XmlElement objectElem = xmldoc.CreateElement("", "Object",
  998. "");
  999. XmlAttribute pos = xmldoc.CreateAttribute("", "pos", "");
  1000. pos.Value=det.OffsetPos.ToString();
  1001. objectElem.Attributes.Append(pos);
  1002. objectElem.AppendChild(
  1003. xmldoc.CreateTextNode(det.Key.ToString()));
  1004. detect.AppendChild(objectElem);
  1005. }
  1006. item.AppendChild(detect);
  1007. queue.AppendChild(item);
  1008. }
  1009. rootElement.AppendChild(queue);
  1010. XmlNode plugins = xmldoc.CreateElement("", "Plugins", "");
  1011. if(instance.PluginData.Length > 0)
  1012. DumpList(xmldoc, plugins,
  1013. new LSL_Types.list(instance.PluginData));
  1014. rootElement.AppendChild(plugins);
  1015. instance.Start();
  1016. return xmldoc.InnerXml;
  1017. }
  1018. public static void Deserialize(string xml, XScriptInstance instance)
  1019. {
  1020. XmlDocument doc = new XmlDocument();
  1021. Dictionary<string, object> vars = instance.GetVars();
  1022. instance.PluginData = new Object[0];
  1023. doc.LoadXml(xml);
  1024. XmlNodeList rootL = doc.GetElementsByTagName("ScriptState");
  1025. if(rootL.Count != 1)
  1026. {
  1027. return;
  1028. }
  1029. XmlNode rootNode = rootL[0];
  1030. if(rootNode != null)
  1031. {
  1032. object varValue;
  1033. XmlNodeList partL = rootNode.ChildNodes;
  1034. foreach (XmlNode part in partL)
  1035. {
  1036. switch(part.Name)
  1037. {
  1038. case "State":
  1039. instance.State=part.InnerText;
  1040. break;
  1041. case "Variables":
  1042. XmlNodeList varL = part.ChildNodes;
  1043. foreach (XmlNode var in varL)
  1044. {
  1045. string varName;
  1046. varValue=ReadTypedValue(var, out varName);
  1047. if(vars.ContainsKey(varName))
  1048. vars[varName] = varValue;
  1049. }
  1050. instance.SetVars(vars);
  1051. break;
  1052. case "Queue":
  1053. XmlNodeList itemL = part.ChildNodes;
  1054. foreach (XmlNode item in itemL)
  1055. {
  1056. List<Object> parms = new List<Object>();
  1057. List<XDetectParams> detected =
  1058. new List<XDetectParams>();
  1059. string eventName =
  1060. item.Attributes.GetNamedItem("event").Value;
  1061. XmlNodeList eventL = item.ChildNodes;
  1062. foreach (XmlNode evt in eventL)
  1063. {
  1064. switch(evt.Name)
  1065. {
  1066. case "Params":
  1067. XmlNodeList prms = evt.ChildNodes;
  1068. foreach (XmlNode pm in prms)
  1069. parms.Add(ReadTypedValue(pm));
  1070. break;
  1071. case "Detected":
  1072. XmlNodeList detL = evt.ChildNodes;
  1073. foreach (XmlNode det in detL)
  1074. {
  1075. string vect =
  1076. det.Attributes.GetNamedItem(
  1077. "pos").Value;
  1078. LSL_Types.Vector3 v =
  1079. new LSL_Types.Vector3(vect);
  1080. LLUUID uuid = new LLUUID();
  1081. LLUUID.TryParse(det.InnerText,
  1082. out uuid);
  1083. XDetectParams d;
  1084. d.Key = uuid;
  1085. d.OffsetPos = v;
  1086. detected.Add(d);
  1087. }
  1088. break;
  1089. }
  1090. }
  1091. XEventParams ep = new XEventParams(
  1092. eventName, parms.ToArray(),
  1093. detected.ToArray());
  1094. instance.EventQueue.Enqueue(ep);
  1095. }
  1096. break;
  1097. case "Plugins":
  1098. instance.PluginData = ReadList(part).Data;
  1099. break;
  1100. }
  1101. }
  1102. }
  1103. }
  1104. private static void DumpList(XmlDocument doc, XmlNode parent,
  1105. LSL_Types.list l)
  1106. {
  1107. foreach (Object o in l.Data)
  1108. WriteTypedValue(doc, parent, "ListItem", "", o);
  1109. }
  1110. private static LSL_Types.list ReadList(XmlNode parent)
  1111. {
  1112. List<Object> olist = new List<Object>();
  1113. XmlNodeList itemL = parent.ChildNodes;
  1114. foreach(XmlNode item in itemL)
  1115. olist.Add(ReadTypedValue(item));
  1116. return new LSL_Types.list(olist.ToArray());
  1117. }
  1118. private static void WriteTypedValue(XmlDocument doc, XmlNode parent,
  1119. string tag, string name, object value)
  1120. {
  1121. Type t=value.GetType();
  1122. XmlAttribute typ = doc.CreateAttribute("", "type", "");
  1123. XmlNode n = doc.CreateElement("", tag, "");
  1124. if(value is LSL_Types.list)
  1125. {
  1126. typ.Value = "list";
  1127. n.Attributes.Append(typ);
  1128. DumpList(doc, n, (LSL_Types.list) value);
  1129. if(name != String.Empty)
  1130. {
  1131. XmlAttribute nam = doc.CreateAttribute("", "name", "");
  1132. nam.Value = name;
  1133. n.Attributes.Append(nam);
  1134. }
  1135. parent.AppendChild(n);
  1136. return;
  1137. }
  1138. n.AppendChild(doc.CreateTextNode(value.ToString()));
  1139. typ.Value = t.ToString();
  1140. n.Attributes.Append(typ);
  1141. if(name != String.Empty)
  1142. {
  1143. XmlAttribute nam = doc.CreateAttribute("", "name", "");
  1144. nam.Value = name;
  1145. n.Attributes.Append(nam);
  1146. }
  1147. parent.AppendChild(n);
  1148. }
  1149. private static object ReadTypedValue(XmlNode tag, out string name)
  1150. {
  1151. name = tag.Attributes.GetNamedItem("name").Value;
  1152. return ReadTypedValue(tag);
  1153. }
  1154. private static object ReadTypedValue(XmlNode tag)
  1155. {
  1156. Object varValue;
  1157. string assembly;
  1158. string itemType = tag.Attributes.GetNamedItem("type").Value;
  1159. if(itemType == "list")
  1160. return ReadList(tag);
  1161. if(itemType == "libsecondlife.LLUUID")
  1162. {
  1163. LLUUID val = new LLUUID();
  1164. LLUUID.TryParse(tag.InnerText, out val);
  1165. return val;
  1166. }
  1167. Type itemT = Type.GetType(itemType);
  1168. if(itemT == null)
  1169. {
  1170. Object[] args =
  1171. new Object[] { tag.InnerText };
  1172. assembly = itemType+", OpenSim.Region.ScriptEngine.XEngine.Script";
  1173. itemT = Type.GetType(assembly);
  1174. if(itemT == null)
  1175. return null;
  1176. varValue = Activator.CreateInstance(itemT, args);
  1177. if(varValue == null)
  1178. return null;
  1179. }
  1180. else
  1181. {
  1182. varValue = Convert.ChangeType(tag.InnerText, itemT);
  1183. }
  1184. return varValue;
  1185. }
  1186. }
  1187. }