1
0

Caps.cs 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  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.IO;
  32. using System.Reflection;
  33. using System.Threading;
  34. using log4net;
  35. using Nini.Config;
  36. using OpenMetaverse;
  37. using OpenSim.Framework.Servers;
  38. using OpenSim.Framework.Servers.HttpServer;
  39. using OpenSim.Services.Interfaces;
  40. // using OpenSim.Region.Framework.Interfaces;
  41. namespace OpenSim.Framework.Capabilities
  42. {
  43. /// <summary>
  44. /// XXX Probably not a particularly nice way of allow us to get the scene presence from the scene (chiefly so that
  45. /// we can popup a message on the user's client if the inventory service has permanently failed). But I didn't want
  46. /// to just pass the whole Scene into CAPS.
  47. /// </summary>
  48. public delegate IClientAPI GetClientDelegate(UUID agentID);
  49. public class Caps : IDisposable
  50. {
  51. private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
  52. private string m_httpListenerHostName;
  53. private uint m_httpListenPort;
  54. /// <summary>
  55. /// This is the uuid portion of every CAPS path. It is used to make capability urls private to the requester.
  56. /// </summary>
  57. private string m_capsObjectPath;
  58. public string CapsObjectPath { get { return m_capsObjectPath; } }
  59. private CapsHandlers m_capsHandlers;
  60. private ConcurrentDictionary<string, PollServiceEventArgs> m_pollServiceHandlers
  61. = new ConcurrentDictionary<string, PollServiceEventArgs>();
  62. private Dictionary<string, string> m_externalCapsHandlers = new Dictionary<string, string>();
  63. private IHttpServer m_httpListener;
  64. private UUID m_agentID;
  65. private string m_regionName;
  66. private ManualResetEvent m_capsActive = new ManualResetEvent(false);
  67. public UUID AgentID
  68. {
  69. get { return m_agentID; }
  70. }
  71. public string RegionName
  72. {
  73. get { return m_regionName; }
  74. }
  75. public string HostName
  76. {
  77. get { return m_httpListenerHostName; }
  78. }
  79. public uint Port
  80. {
  81. get { return m_httpListenPort; }
  82. }
  83. public IHttpServer HttpListener
  84. {
  85. get { return m_httpListener; }
  86. }
  87. public bool SSLCaps
  88. {
  89. get { return m_httpListener.UseSSL; }
  90. }
  91. public string SSLCommonName
  92. {
  93. get { return m_httpListener.SSLCommonName; }
  94. }
  95. public CapsHandlers CapsHandlers
  96. {
  97. get { return m_capsHandlers; }
  98. }
  99. public Dictionary<string, string> ExternalCapsHandlers
  100. {
  101. get { return m_externalCapsHandlers; }
  102. }
  103. [Flags]
  104. public enum CapsFlags:uint
  105. {
  106. None = 0,
  107. SentSeeds = 1,
  108. ObjectAnim = 0x100,
  109. WLEnv = 0x200,
  110. AdvEnv = 0x400
  111. }
  112. public CapsFlags Flags { get; set;}
  113. public Caps(IHttpServer httpServer, string httpListen, uint httpPort, string capsPath,
  114. UUID agent, string regionName)
  115. {
  116. m_capsObjectPath = capsPath;
  117. m_httpListener = httpServer;
  118. m_httpListenerHostName = httpListen;
  119. m_httpListenPort = httpPort;
  120. if (httpServer != null && httpServer.UseSSL)
  121. {
  122. m_httpListenPort = httpServer.SSLPort;
  123. httpListen = httpServer.SSLCommonName;
  124. httpPort = httpServer.SSLPort;
  125. }
  126. m_agentID = agent;
  127. m_capsHandlers = new CapsHandlers(httpServer, httpListen, httpPort);
  128. m_regionName = regionName;
  129. Flags = CapsFlags.None;
  130. m_capsActive.Reset();
  131. }
  132. ~Caps()
  133. {
  134. Dispose(false);
  135. }
  136. public void Dispose()
  137. {
  138. Dispose(true);
  139. GC.SuppressFinalize(this);
  140. }
  141. protected void Dispose(bool disposing)
  142. {
  143. Flags = CapsFlags.None;
  144. if (m_capsActive != null)
  145. {
  146. DeregisterHandlers();
  147. m_capsActive.Dispose();
  148. m_capsActive = null;
  149. }
  150. }
  151. /// <summary>
  152. /// Register a handler. This allows modules to register handlers.
  153. /// </summary>
  154. /// <param name="capName"></param>
  155. /// <param name="handler"></param>
  156. public void RegisterHandler(string capName, IRequestHandler handler)
  157. {
  158. //m_log.DebugFormat("[CAPS]: Registering handler for \"{0}\": path {1}", capName, handler.Path);
  159. m_capsHandlers[capName] = handler;
  160. }
  161. public void RegisterSimpleHandler(string capName, ISimpleStreamHandler handler, bool addToListener = true)
  162. {
  163. //m_log.DebugFormat("[CAPS]: Registering handler for \"{0}\": path {1}", capName, handler.Path);
  164. m_capsHandlers.AddSimpleHandler(capName, handler, addToListener);
  165. }
  166. public void RegisterPollHandler(string capName, PollServiceEventArgs pollServiceHandler)
  167. {
  168. // m_log.DebugFormat(
  169. // "[CAPS]: Registering handler with name {0}, url {1} for {2}",
  170. // capName, pollServiceHandler.Url, m_agentID, m_regionName);
  171. if(!m_pollServiceHandlers.TryAdd(capName, pollServiceHandler))
  172. {
  173. m_log.ErrorFormat(
  174. "[CAPS]: Handler with name {0} already registered (ulr {1}, agent {2}, region {3}",
  175. capName, pollServiceHandler.Url, m_agentID, m_regionName);
  176. return;
  177. }
  178. m_httpListener.AddPollServiceHTTPHandler(pollServiceHandler);
  179. // uint port = (MainServer.Instance == null) ? 0 : MainServer.Instance.Port;
  180. // string protocol = "http";
  181. // string hostName = m_httpListenerHostName;
  182. //
  183. // if (MainServer.Instance.UseSSL)
  184. // {
  185. // hostName = MainServer.Instance.SSLCommonName;
  186. // port = MainServer.Instance.SSLPort;
  187. // protocol = "https";
  188. // }
  189. // RegisterHandler(
  190. // capName, String.Format("{0}://{1}:{2}{3}", protocol, hostName, port, pollServiceHandler.Url));
  191. }
  192. /// <summary>
  193. /// Register an external handler. The service for this capability is somewhere else
  194. /// given by the URL.
  195. /// </summary>
  196. /// <param name="capsName"></param>
  197. /// <param name="url"></param>
  198. public void RegisterHandler(string capsName, string url)
  199. {
  200. m_externalCapsHandlers.Add(capsName, url);
  201. }
  202. /// <summary>
  203. /// Remove all CAPS service handlers.
  204. /// </summary>
  205. public void DeregisterHandlers()
  206. {
  207. foreach (string capsName in m_capsHandlers.Caps)
  208. {
  209. m_capsHandlers.Remove(capsName);
  210. }
  211. foreach (PollServiceEventArgs handler in m_pollServiceHandlers.Values)
  212. {
  213. m_httpListener.RemovePollServiceHTTPHandler(handler.Url);
  214. }
  215. m_pollServiceHandlers.Clear();
  216. }
  217. public bool TryGetPollHandler(string name, out PollServiceEventArgs pollHandler)
  218. {
  219. return m_pollServiceHandlers.TryGetValue(name, out pollHandler);
  220. }
  221. public Dictionary<string, PollServiceEventArgs> GetPollHandlers()
  222. {
  223. return new Dictionary<string, PollServiceEventArgs>(m_pollServiceHandlers);
  224. }
  225. /// <summary>
  226. /// Return an LLSD-serializable Hashtable describing the
  227. /// capabilities and their handler details.
  228. /// </summary>
  229. /// <param name="excludeSeed">If true, then exclude the seed cap.</param>
  230. public Hashtable GetCapsDetails(bool excludeSeed, List<string> requestedCaps)
  231. {
  232. Hashtable caps = CapsHandlers.GetCapsDetails(excludeSeed, requestedCaps);
  233. lock (m_pollServiceHandlers)
  234. {
  235. foreach (KeyValuePair <string, PollServiceEventArgs> kvp in m_pollServiceHandlers)
  236. {
  237. if (!requestedCaps.Contains(kvp.Key))
  238. continue;
  239. string hostName = m_httpListenerHostName;
  240. uint port = (MainServer.Instance == null) ? 0 : MainServer.Instance.Port;
  241. string protocol = "http";
  242. if (MainServer.Instance.UseSSL)
  243. {
  244. hostName = MainServer.Instance.SSLCommonName;
  245. port = MainServer.Instance.SSLPort;
  246. protocol = "https";
  247. }
  248. caps[kvp.Key] = string.Format("{0}://{1}:{2}{3}", protocol, hostName, port, kvp.Value.Url);
  249. }
  250. }
  251. // Add the external too
  252. foreach (KeyValuePair<string, string> kvp in ExternalCapsHandlers)
  253. {
  254. if (!requestedCaps.Contains(kvp.Key))
  255. continue;
  256. caps[kvp.Key] = kvp.Value;
  257. }
  258. return caps;
  259. }
  260. public void Activate()
  261. {
  262. m_capsActive.Set();
  263. }
  264. public bool WaitForActivation()
  265. {
  266. // Wait for 30s. If that elapses, return false and run without caps
  267. return m_capsActive.WaitOne(120000);
  268. }
  269. }
  270. }