1
0

Caps.cs 9.2 KB

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