Caps.cs 9.8 KB

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