1
0

GetAssetsModule.cs 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497
  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. using System;
  28. using System.Collections;
  29. using System.Collections.Generic;
  30. using System.Collections.Concurrent;
  31. using System.Reflection;
  32. using System.Threading;
  33. using Mono.Addins;
  34. using OpenSim.Framework.Monitoring;
  35. using log4net;
  36. using Nini.Config;
  37. using OpenMetaverse;
  38. using OpenSim.Capabilities.Handlers;
  39. using OpenSim.Framework;
  40. using OpenSim.Framework.Servers;
  41. using OpenSim.Framework.Servers.HttpServer;
  42. using OpenSim.Region.Framework.Interfaces;
  43. using OpenSim.Region.Framework.Scenes;
  44. using OpenSim.Services.Interfaces;
  45. using Caps = OpenSim.Framework.Capabilities.Caps;
  46. namespace OpenSim.Region.ClientStack.Linden
  47. {
  48. [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "GetAssetsModule")]
  49. public class GetAssetsModule : INonSharedRegionModule
  50. {
  51. // private static readonly ILog m_log =
  52. // LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
  53. private Scene m_scene;
  54. private bool m_Enabled;
  55. private string m_GetTextureURL;
  56. private string m_GetMeshURL;
  57. private string m_GetMesh2URL;
  58. private string m_GetAssetURL;
  59. class APollRequest
  60. {
  61. public PollServiceAssetEventArgs thepoll;
  62. public UUID reqID;
  63. public Hashtable request;
  64. }
  65. public class APollResponse
  66. {
  67. public Hashtable response;
  68. public int bytes;
  69. public bool throttle;
  70. }
  71. private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
  72. private static IAssetService m_assetService = null;
  73. private static GetAssetsHandler m_getAssetHandler;
  74. private static Thread[] m_workerThreads = null;
  75. private static int m_NumberScenes = 0;
  76. private static BlockingCollection<APollRequest> m_queue = new BlockingCollection<APollRequest>();
  77. private static object m_loadLock = new object();
  78. private Dictionary<UUID, string> m_capsDictTexture = new Dictionary<UUID, string>();
  79. private Dictionary<UUID, string> m_capsDictGetMesh = new Dictionary<UUID, string>();
  80. private Dictionary<UUID, string> m_capsDictGetMesh2 = new Dictionary<UUID, string>();
  81. private Dictionary<UUID, string> m_capsDictGetAsset = new Dictionary<UUID, string>();
  82. #region Region Module interfaceBase Members
  83. public Type ReplaceableInterface
  84. {
  85. get { return null; }
  86. }
  87. public void Initialise(IConfigSource source)
  88. {
  89. IConfig config = source.Configs["ClientStack.LindenCaps"];
  90. if (config == null)
  91. return;
  92. m_GetTextureURL = config.GetString("Cap_GetTexture", string.Empty);
  93. if (m_GetTextureURL != string.Empty)
  94. m_Enabled = true;
  95. m_GetMeshURL = config.GetString("Cap_GetMesh", string.Empty);
  96. if (m_GetMeshURL != string.Empty)
  97. m_Enabled = true;
  98. m_GetMesh2URL = config.GetString("Cap_GetMesh2", string.Empty);
  99. if (m_GetMesh2URL != string.Empty)
  100. m_Enabled = true;
  101. m_GetAssetURL = config.GetString("Cap_GetAsset", string.Empty);
  102. if (m_GetAssetURL != string.Empty)
  103. m_Enabled = true;
  104. }
  105. public void AddRegion(Scene pScene)
  106. {
  107. if (!m_Enabled)
  108. return;
  109. m_scene = pScene;
  110. }
  111. public void RemoveRegion(Scene s)
  112. {
  113. if (!m_Enabled)
  114. return;
  115. s.EventManager.OnRegisterCaps -= RegisterCaps;
  116. s.EventManager.OnDeregisterCaps -= DeregisterCaps;
  117. m_NumberScenes--;
  118. m_scene = null;
  119. }
  120. public void RegionLoaded(Scene s)
  121. {
  122. if (!m_Enabled)
  123. return;
  124. lock(m_loadLock)
  125. {
  126. if (m_assetService == null && m_NumberScenes == 0)
  127. {
  128. m_assetService = s.RequestModuleInterface<IAssetService>();
  129. // We'll reuse the same handler for all requests.
  130. m_getAssetHandler = new GetAssetsHandler(m_assetService);
  131. }
  132. if (m_assetService == null)
  133. {
  134. m_Enabled = false;
  135. return;
  136. }
  137. s.EventManager.OnRegisterCaps += RegisterCaps;
  138. s.EventManager.OnDeregisterCaps += DeregisterCaps;
  139. m_NumberScenes++;
  140. if (m_workerThreads == null)
  141. {
  142. m_workerThreads = new Thread[3];
  143. for (uint i = 0; i < 3; i++)
  144. {
  145. m_workerThreads[i] = WorkManager.StartThread(DoAssetRequests,
  146. String.Format("GetCapsAssetWorker{0}", i),
  147. ThreadPriority.Normal,
  148. true,
  149. false,
  150. null,
  151. int.MaxValue);
  152. }
  153. }
  154. }
  155. }
  156. public void Close()
  157. {
  158. if(m_NumberScenes <= 0 && m_workerThreads != null)
  159. {
  160. m_log.DebugFormat("[GetAssetsModule] Closing");
  161. foreach (Thread t in m_workerThreads)
  162. Watchdog.AbortThread(t.ManagedThreadId);
  163. // This will fail on region shutdown. Its harmless.
  164. // Prevent red ink.
  165. try
  166. {
  167. m_queue.Dispose();
  168. }
  169. catch {}
  170. }
  171. }
  172. public string Name { get { return "GetAssetsModule"; } }
  173. #endregion
  174. private static void DoAssetRequests()
  175. {
  176. try
  177. {
  178. while (m_NumberScenes > 0)
  179. {
  180. APollRequest poolreq;
  181. if (m_queue.TryTake(out poolreq, 4500))
  182. {
  183. if (m_NumberScenes <= 0)
  184. break;
  185. Watchdog.UpdateThread();
  186. if (poolreq.reqID != UUID.Zero)
  187. poolreq.thepoll.Process(poolreq);
  188. poolreq = null;
  189. }
  190. Watchdog.UpdateThread();
  191. }
  192. }
  193. catch (ThreadAbortException)
  194. {
  195. Thread.ResetAbort();
  196. }
  197. }
  198. private class PollServiceAssetEventArgs : PollServiceEventArgs
  199. {
  200. private List<Hashtable> requests = new List<Hashtable>();
  201. private Dictionary<UUID, APollResponse> responses =new Dictionary<UUID, APollResponse>();
  202. private HashSet<UUID> dropedResponses = new HashSet<UUID>();
  203. private Scene m_scene;
  204. private ScenePresence m_presence;
  205. public PollServiceAssetEventArgs(string uri, UUID pId, Scene scene) :
  206. base(null, uri, null, null, null, null, pId, int.MaxValue)
  207. {
  208. m_scene = scene;
  209. // x is request id, y is userid
  210. HasEvents = (x, y) =>
  211. {
  212. lock (responses)
  213. {
  214. APollResponse response;
  215. if (responses.TryGetValue(x, out response))
  216. {
  217. if (m_presence == null)
  218. m_presence = m_scene.GetScenePresence(pId);
  219. if (m_presence == null || m_presence.IsDeleted)
  220. return true;
  221. if(response.throttle)
  222. return m_presence.CapCanSendAsset(1, response.bytes);
  223. return m_presence.CapCanSendAsset(2, response.bytes);
  224. }
  225. return false;
  226. }
  227. };
  228. Drop = (x, y) =>
  229. {
  230. lock (responses)
  231. {
  232. responses.Remove(x);
  233. lock(dropedResponses)
  234. dropedResponses.Add(x);
  235. }
  236. };
  237. GetEvents = (x, y) =>
  238. {
  239. lock (responses)
  240. {
  241. try
  242. {
  243. return responses[x].response;
  244. }
  245. finally
  246. {
  247. responses.Remove(x);
  248. }
  249. }
  250. };
  251. // x is request id, y is request data hashtable
  252. Request = (x, y) =>
  253. {
  254. APollRequest reqinfo = new APollRequest();
  255. reqinfo.thepoll = this;
  256. reqinfo.reqID = x;
  257. reqinfo.request = y;
  258. m_queue.Add(reqinfo);
  259. };
  260. // this should never happen except possible on shutdown
  261. NoEvents = (x, y) =>
  262. {
  263. /*
  264. lock (requests)
  265. {
  266. Hashtable request = requests.Find(id => id["RequestID"].ToString() == x.ToString());
  267. requests.Remove(request);
  268. }
  269. */
  270. Hashtable response = new Hashtable();
  271. response["int_response_code"] = 500;
  272. response["str_response_string"] = "timeout";
  273. response["content_type"] = "text/plain";
  274. response["keepalive"] = false;
  275. return response;
  276. };
  277. }
  278. public void Process(APollRequest requestinfo)
  279. {
  280. Hashtable curresponse;
  281. UUID requestID = requestinfo.reqID;
  282. if(m_scene.ShuttingDown)
  283. return;
  284. lock(responses)
  285. {
  286. lock(dropedResponses)
  287. {
  288. if(dropedResponses.Contains(requestID))
  289. {
  290. dropedResponses.Remove(requestID);
  291. return;
  292. }
  293. }
  294. /* can't do this with current viewers; HG problem
  295. // If the avatar is gone, don't bother to get the texture
  296. if(m_scene.GetScenePresence(Id) == null)
  297. {
  298. curresponse = new Hashtable();
  299. curresponse["int_response_code"] = 500;
  300. curresponse["str_response_string"] = "timeout";
  301. curresponse["content_type"] = "text/plain";
  302. curresponse["keepalive"] = false;
  303. responses[requestID] = new APollResponse() { bytes = 0, response = curresponse };
  304. return;
  305. }
  306. */
  307. }
  308. curresponse = m_getAssetHandler.Handle(requestinfo.request);
  309. lock(responses)
  310. {
  311. lock(dropedResponses)
  312. {
  313. if(dropedResponses.Contains(requestID))
  314. {
  315. dropedResponses.Remove(requestID);
  316. return;
  317. }
  318. }
  319. APollResponse preq= new APollResponse()
  320. {
  321. bytes = (int)curresponse["int_bytes"],
  322. response = curresponse
  323. };
  324. if(curresponse.Contains("throttle"))
  325. preq.throttle = true;
  326. responses[requestID] = preq;
  327. }
  328. }
  329. }
  330. public void RegisterCaps(UUID agentID, Caps caps)
  331. {
  332. string hostName = m_scene.RegionInfo.ExternalHostName;
  333. uint port = (MainServer.Instance == null) ? 0 : MainServer.Instance.Port;
  334. string protocol = "http";
  335. if (MainServer.Instance.UseSSL)
  336. {
  337. hostName = MainServer.Instance.SSLCommonName;
  338. port = MainServer.Instance.SSLPort;
  339. protocol = "https";
  340. }
  341. string baseURL = String.Format("{0}://{1}:{2}", protocol, hostName, port);
  342. if (m_GetTextureURL == "localhost")
  343. {
  344. string capUrl = "/CAPS/" + UUID.Random() + "/";
  345. // Register this as a poll service
  346. PollServiceAssetEventArgs args = new PollServiceAssetEventArgs(capUrl, agentID, m_scene);
  347. args.Type = PollServiceEventArgs.EventType.Texture;
  348. MainServer.Instance.AddPollServiceHTTPHandler(capUrl, args);
  349. IExternalCapsModule handler = m_scene.RequestModuleInterface<IExternalCapsModule>();
  350. if (handler != null)
  351. handler.RegisterExternalUserCapsHandler(agentID, caps, "GetTexture", capUrl);
  352. else
  353. caps.RegisterHandler("GetTexture", baseURL + capUrl);
  354. m_capsDictTexture[agentID] = capUrl;
  355. }
  356. else
  357. {
  358. caps.RegisterHandler("GetTexture", m_GetTextureURL);
  359. }
  360. //GetMesh
  361. if (m_GetMeshURL == "localhost")
  362. {
  363. string capUrl = "/CAPS/" + UUID.Random() + "/";
  364. PollServiceAssetEventArgs args = new PollServiceAssetEventArgs(capUrl, agentID, m_scene);
  365. args.Type = PollServiceEventArgs.EventType.Mesh;
  366. MainServer.Instance.AddPollServiceHTTPHandler(capUrl, args);
  367. IExternalCapsModule handler = m_scene.RequestModuleInterface<IExternalCapsModule>();
  368. if (handler != null)
  369. handler.RegisterExternalUserCapsHandler(agentID, caps, "GetMesh", capUrl);
  370. else
  371. caps.RegisterHandler("GetMesh", baseURL + capUrl);
  372. m_capsDictGetMesh[agentID] = capUrl;
  373. }
  374. else if (m_GetMeshURL != string.Empty)
  375. caps.RegisterHandler("GetMesh", m_GetMeshURL);
  376. //GetMesh2
  377. if (m_GetMesh2URL == "localhost")
  378. {
  379. string capUrl = "/CAPS/" + UUID.Random() + "/";
  380. PollServiceAssetEventArgs args = new PollServiceAssetEventArgs(capUrl, agentID, m_scene);
  381. args.Type = PollServiceEventArgs.EventType.Mesh2;
  382. MainServer.Instance.AddPollServiceHTTPHandler(capUrl, args);
  383. IExternalCapsModule handler = m_scene.RequestModuleInterface<IExternalCapsModule>();
  384. if (handler != null)
  385. handler.RegisterExternalUserCapsHandler(agentID, caps, "GetMesh2", capUrl);
  386. else
  387. caps.RegisterHandler("GetMesh2", baseURL + capUrl);
  388. m_capsDictGetMesh2[agentID] = capUrl;
  389. }
  390. else if (m_GetMesh2URL != string.Empty)
  391. caps.RegisterHandler("GetMesh2", m_GetMesh2URL);
  392. //ViewerAsset
  393. if (m_GetAssetURL == "localhost")
  394. {
  395. string capUrl = "/CAPS/" + UUID.Random() + "/";
  396. PollServiceAssetEventArgs args = new PollServiceAssetEventArgs(capUrl, agentID, m_scene);
  397. args.Type = PollServiceEventArgs.EventType.Asset;
  398. MainServer.Instance.AddPollServiceHTTPHandler(capUrl, args);
  399. IExternalCapsModule handler = m_scene.RequestModuleInterface<IExternalCapsModule>();
  400. if (handler != null)
  401. handler.RegisterExternalUserCapsHandler(agentID, caps, "ViewerAsset", capUrl);
  402. else
  403. caps.RegisterHandler("ViewerAsset", baseURL + capUrl);
  404. m_capsDictGetAsset[agentID] = capUrl;
  405. }
  406. else if (m_GetAssetURL != string.Empty)
  407. caps.RegisterHandler("ViewerAsset", m_GetMesh2URL);
  408. }
  409. private void DeregisterCaps(UUID agentID, Caps caps)
  410. {
  411. string capUrl;
  412. if (m_capsDictTexture.TryGetValue(agentID, out capUrl))
  413. {
  414. MainServer.Instance.RemovePollServiceHTTPHandler("", capUrl);
  415. m_capsDictTexture.Remove(agentID);
  416. }
  417. if (m_capsDictGetMesh.TryGetValue(agentID, out capUrl))
  418. {
  419. MainServer.Instance.RemovePollServiceHTTPHandler("", capUrl);
  420. m_capsDictGetMesh.Remove(agentID);
  421. }
  422. if (m_capsDictGetMesh2.TryGetValue(agentID, out capUrl))
  423. {
  424. MainServer.Instance.RemovePollServiceHTTPHandler("", capUrl);
  425. m_capsDictGetMesh2.Remove(agentID);
  426. }
  427. if (m_capsDictGetAsset.TryGetValue(agentID, out capUrl))
  428. {
  429. MainServer.Instance.RemovePollServiceHTTPHandler("", capUrl);
  430. m_capsDictGetAsset.Remove(agentID);
  431. }
  432. }
  433. }
  434. }