DataSnapshotManager.cs 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438
  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 OpenSimulator 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. */
  28. using System;
  29. using System.Collections.Generic;
  30. using System.IO;
  31. using System.Net;
  32. using System.Reflection;
  33. using System.Xml;
  34. using log4net;
  35. using Nini.Config;
  36. using OpenMetaverse;
  37. using OpenSim.Framework;
  38. using OpenSim.Framework.Communications;
  39. using OpenSim.Region.DataSnapshot.Interfaces;
  40. using OpenSim.Region.Framework.Interfaces;
  41. using OpenSim.Region.Framework.Scenes;
  42. namespace OpenSim.Region.DataSnapshot
  43. {
  44. public class DataSnapshotManager : IRegionModule, IDataSnapshot
  45. {
  46. #region Class members
  47. //Information from config
  48. private bool m_enabled = false;
  49. private bool m_configLoaded = false;
  50. private List<string> m_disabledModules = new List<string>();
  51. private Dictionary<string, string> m_gridinfo = new Dictionary<string, string>();
  52. private string m_snapsDir = "DataSnapshot";
  53. private string m_exposure_level = "minimum";
  54. //Lists of stuff we need
  55. private List<Scene> m_scenes = new List<Scene>();
  56. private List<IDataSnapshotProvider> m_dataproviders = new List<IDataSnapshotProvider>();
  57. //Various internal objects
  58. private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
  59. internal object m_syncInit = new object();
  60. //DataServices and networking
  61. private string m_dataServices = "noservices";
  62. public string m_listener_port = ConfigSettings.DefaultRegionHttpPort.ToString();
  63. public string m_hostname = "127.0.0.1";
  64. //Update timers
  65. private int m_period = 20; // in seconds
  66. private int m_maxStales = 500;
  67. private int m_stales = 0;
  68. private int m_lastUpdate = 0;
  69. //Program objects
  70. private SnapshotStore m_snapStore = null;
  71. #endregion
  72. #region Properties
  73. public string ExposureLevel
  74. {
  75. get { return m_exposure_level; }
  76. }
  77. #endregion
  78. #region IRegionModule
  79. public void Initialise(Scene scene, IConfigSource config)
  80. {
  81. if (!m_configLoaded)
  82. {
  83. m_configLoaded = true;
  84. m_log.Info("[DATASNAPSHOT]: Loading configuration");
  85. //Read from the config for options
  86. lock (m_syncInit)
  87. {
  88. try
  89. {
  90. m_enabled = config.Configs["DataSnapshot"].GetBoolean("index_sims", m_enabled);
  91. if (config.Configs["Startup"].GetBoolean("gridmode", false))
  92. {
  93. m_gridinfo.Add(
  94. "gridserverURL",
  95. config.Configs["Network"].GetString(
  96. "grid_server_url", "http://127.0.0.1:" + ConfigSettings.DefaultGridServerHttpPort.ToString()));
  97. m_gridinfo.Add(
  98. "userserverURL",
  99. config.Configs["Network"].GetString(
  100. "user_server_url", "http://127.0.0.1:" + ConfigSettings.DefaultUserServerHttpPort.ToString()));
  101. m_gridinfo.Add(
  102. "assetserverURL",
  103. config.Configs["Network"].GetString(
  104. "asset_server_url", "http://127.0.0.1:" + ConfigSettings.DefaultAssetServerHttpPort.ToString()));
  105. }
  106. m_gridinfo.Add(
  107. "Name", config.Configs["DataSnapshot"].GetString("gridname", "the lost continent of hippo"));
  108. m_exposure_level = config.Configs["DataSnapshot"].GetString("data_exposure", m_exposure_level);
  109. m_period = config.Configs["DataSnapshot"].GetInt("default_snapshot_period", m_period);
  110. m_maxStales = config.Configs["DataSnapshot"].GetInt("max_changes_before_update", m_maxStales);
  111. m_snapsDir = config.Configs["DataSnapshot"].GetString("snapshot_cache_directory", m_snapsDir);
  112. m_dataServices = config.Configs["DataSnapshot"].GetString("data_services", m_dataServices);
  113. m_listener_port = config.Configs["Network"].GetString("http_listener_port", m_listener_port);
  114. String[] annoying_string_array = config.Configs["DataSnapshot"].GetString("disable_modules", "").Split(".".ToCharArray());
  115. foreach (String bloody_wanker in annoying_string_array)
  116. {
  117. m_disabledModules.Add(bloody_wanker);
  118. }
  119. m_lastUpdate = Environment.TickCount;
  120. }
  121. catch (Exception)
  122. {
  123. m_log.Info("[DATASNAPSHOT]: Could not load configuration. DataSnapshot will be disabled.");
  124. m_enabled = false;
  125. return;
  126. }
  127. }
  128. if (m_enabled)
  129. {
  130. //Hand it the first scene, assuming that all scenes have the same BaseHTTPServer
  131. new DataRequestHandler(scene, this);
  132. m_hostname = scene.RegionInfo.ExternalHostName;
  133. m_snapStore = new SnapshotStore(m_snapsDir, m_gridinfo, m_listener_port, m_hostname);
  134. MakeEverythingStale();
  135. if (m_dataServices != "" && m_dataServices != "noservices")
  136. NotifyDataServices(m_dataServices, "online");
  137. }
  138. }
  139. if (m_enabled)
  140. {
  141. m_log.Info("[DATASNAPSHOT]: Scene added to module.");
  142. m_snapStore.AddScene(scene);
  143. m_scenes.Add(scene);
  144. Assembly currentasm = Assembly.GetExecutingAssembly();
  145. foreach (Type pluginType in currentasm.GetTypes())
  146. {
  147. if (pluginType.IsPublic)
  148. {
  149. if (!pluginType.IsAbstract)
  150. {
  151. if (pluginType.GetInterface("IDataSnapshotProvider") != null)
  152. {
  153. IDataSnapshotProvider module = (IDataSnapshotProvider)Activator.CreateInstance(pluginType);
  154. module.Initialize(scene, this);
  155. module.OnStale += MarkDataStale;
  156. m_dataproviders.Add(module);
  157. m_snapStore.AddProvider(module);
  158. m_log.Info("[DATASNAPSHOT]: Added new data provider type: " + pluginType.Name);
  159. }
  160. }
  161. }
  162. }
  163. //scene.OnRestart += OnSimRestart;
  164. scene.EventManager.OnShutdown += delegate() { OnSimRestart(scene.RegionInfo); };
  165. }
  166. else
  167. {
  168. m_log.Warn("[DATASNAPSHOT]: Data snapshot disabled, not adding scene to module (or anything else).");
  169. }
  170. }
  171. public void Close()
  172. {
  173. if (m_enabled && m_dataServices != "" && m_dataServices != "noservices")
  174. NotifyDataServices(m_dataServices, "offline");
  175. }
  176. public bool IsSharedModule
  177. {
  178. get { return true; }
  179. }
  180. public string Name
  181. {
  182. get { return "External Data Generator"; }
  183. }
  184. public void PostInitialise()
  185. {
  186. }
  187. #endregion
  188. #region Associated helper functions
  189. public Scene SceneForName(string name)
  190. {
  191. foreach (Scene scene in m_scenes)
  192. if (scene.RegionInfo.RegionName == name)
  193. return scene;
  194. return null;
  195. }
  196. public Scene SceneForUUID(UUID id)
  197. {
  198. foreach (Scene scene in m_scenes)
  199. if (scene.RegionInfo.RegionID == id)
  200. return scene;
  201. return null;
  202. }
  203. #endregion
  204. #region [Public] Snapshot storage functions
  205. /**
  206. * Reply to the http request
  207. */
  208. public XmlDocument GetSnapshot(string regionName)
  209. {
  210. CheckStale();
  211. XmlDocument requestedSnap = new XmlDocument();
  212. requestedSnap.AppendChild(requestedSnap.CreateXmlDeclaration("1.0", null, null));
  213. requestedSnap.AppendChild(requestedSnap.CreateWhitespace("\r\n"));
  214. XmlNode regiondata = requestedSnap.CreateNode(XmlNodeType.Element, "regiondata", "");
  215. try
  216. {
  217. if (regionName == null || regionName == "")
  218. {
  219. XmlNode timerblock = requestedSnap.CreateNode(XmlNodeType.Element, "expire", "");
  220. timerblock.InnerText = m_period.ToString();
  221. regiondata.AppendChild(timerblock);
  222. regiondata.AppendChild(requestedSnap.CreateWhitespace("\r\n"));
  223. foreach (Scene scene in m_scenes)
  224. {
  225. regiondata.AppendChild(m_snapStore.GetScene(scene, requestedSnap));
  226. }
  227. }
  228. else
  229. {
  230. Scene scene = SceneForName(regionName);
  231. regiondata.AppendChild(m_snapStore.GetScene(scene, requestedSnap));
  232. }
  233. requestedSnap.AppendChild(regiondata);
  234. regiondata.AppendChild(requestedSnap.CreateWhitespace("\r\n"));
  235. }
  236. catch (XmlException e)
  237. {
  238. m_log.Warn("[DATASNAPSHOT]: XmlException while trying to load snapshot: " + e.ToString());
  239. requestedSnap = GetErrorMessage(regionName, e);
  240. }
  241. catch (Exception e)
  242. {
  243. m_log.Warn("[DATASNAPSHOT]: Caught unknown exception while trying to load snapshot: " + e.StackTrace);
  244. requestedSnap = GetErrorMessage(regionName, e);
  245. }
  246. return requestedSnap;
  247. }
  248. private XmlDocument GetErrorMessage(string regionName, Exception e)
  249. {
  250. XmlDocument errorMessage = new XmlDocument();
  251. XmlNode error = errorMessage.CreateNode(XmlNodeType.Element, "error", "");
  252. XmlNode region = errorMessage.CreateNode(XmlNodeType.Element, "region", "");
  253. region.InnerText = regionName;
  254. XmlNode exception = errorMessage.CreateNode(XmlNodeType.Element, "exception", "");
  255. exception.InnerText = e.ToString();
  256. error.AppendChild(region);
  257. error.AppendChild(exception);
  258. errorMessage.AppendChild(error);
  259. return errorMessage;
  260. }
  261. #endregion
  262. #region External data services
  263. private void NotifyDataServices(string servicesStr, string serviceName)
  264. {
  265. Stream reply = null;
  266. string delimStr = ";";
  267. char [] delimiter = delimStr.ToCharArray();
  268. string[] services = servicesStr.Split(delimiter);
  269. for (int i = 0; i < services.Length; i++)
  270. {
  271. string url = services[i].Trim();
  272. RestClient cli = new RestClient(url);
  273. cli.AddQueryParameter("service", serviceName);
  274. cli.AddQueryParameter("host", m_hostname);
  275. cli.AddQueryParameter("port", m_listener_port);
  276. cli.RequestMethod = "GET";
  277. try
  278. {
  279. reply = cli.Request();
  280. }
  281. catch (WebException)
  282. {
  283. m_log.Warn("[DATASNAPSHOT]: Unable to notify " + url);
  284. }
  285. catch (Exception e)
  286. {
  287. m_log.Warn("[DATASNAPSHOT]: Ignoring unknown exception " + e.ToString());
  288. }
  289. byte[] response = new byte[1024];
  290. // int n = 0;
  291. try
  292. {
  293. // n = reply.Read(response, 0, 1024);
  294. reply.Read(response, 0, 1024);
  295. }
  296. catch (Exception e)
  297. {
  298. m_log.WarnFormat("[DATASNAPSHOT]: Unable to decode reply from data service. Ignoring. {0}", e.StackTrace);
  299. }
  300. // This is not quite working, so...
  301. // string responseStr = Util.UTF8.GetString(response);
  302. m_log.Info("[DATASNAPSHOT]: data service notified: " + url);
  303. }
  304. }
  305. #endregion
  306. #region Latency-based update functions
  307. public void MarkDataStale(IDataSnapshotProvider provider)
  308. {
  309. //Behavior here: Wait m_period seconds, then update if there has not been a request in m_period seconds
  310. //or m_maxStales has been exceeded
  311. m_stales++;
  312. }
  313. private void CheckStale()
  314. {
  315. // Wrap check
  316. if (Environment.TickCount < m_lastUpdate)
  317. {
  318. m_lastUpdate = Environment.TickCount;
  319. }
  320. if (m_stales >= m_maxStales)
  321. {
  322. if (Environment.TickCount - m_lastUpdate >= 20000)
  323. {
  324. m_stales = 0;
  325. m_lastUpdate = Environment.TickCount;
  326. MakeEverythingStale();
  327. }
  328. }
  329. else
  330. {
  331. if (m_lastUpdate + 1000 * m_period < Environment.TickCount)
  332. {
  333. m_stales = 0;
  334. m_lastUpdate = Environment.TickCount;
  335. MakeEverythingStale();
  336. }
  337. }
  338. }
  339. public void MakeEverythingStale()
  340. {
  341. m_log.Debug("[DATASNAPSHOT]: Marking all scenes as stale.");
  342. foreach (Scene scene in m_scenes)
  343. {
  344. m_snapStore.ForceSceneStale(scene);
  345. }
  346. }
  347. #endregion
  348. public void OnSimRestart(RegionInfo thisRegion)
  349. {
  350. m_log.Info("[DATASNAPSHOT]: Region " + thisRegion.RegionName + " is restarting, removing from indexing");
  351. Scene restartedScene = SceneForUUID(thisRegion.RegionID);
  352. m_scenes.Remove(restartedScene);
  353. m_snapStore.RemoveScene(restartedScene);
  354. //Getting around the fact that we can't remove objects from a collection we are enumerating over
  355. List<IDataSnapshotProvider> providersToRemove = new List<IDataSnapshotProvider>();
  356. foreach (IDataSnapshotProvider provider in m_dataproviders)
  357. {
  358. if (provider.GetParentScene == restartedScene)
  359. {
  360. providersToRemove.Add(provider);
  361. }
  362. }
  363. foreach (IDataSnapshotProvider provider in providersToRemove)
  364. {
  365. m_dataproviders.Remove(provider);
  366. m_snapStore.RemoveProvider(provider);
  367. }
  368. m_snapStore.RemoveScene(restartedScene);
  369. }
  370. }
  371. }