SimulationServiceConnector.cs 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452
  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.Generic;
  29. using System.IO;
  30. using System.Net;
  31. using System.Reflection;
  32. using System.Text;
  33. using System.Collections;
  34. using OpenSim.Framework;
  35. using OpenSim.Services.Interfaces;
  36. using GridRegion = OpenSim.Services.Interfaces.GridRegion;
  37. using OpenMetaverse;
  38. using OpenMetaverse.StructuredData;
  39. using log4net;
  40. using Nini.Config;
  41. namespace OpenSim.Services.Connectors.Simulation
  42. {
  43. public class SimulationServiceConnector : ISimulationService
  44. {
  45. private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
  46. // we use this dictionary to track the pending updateagent requests, maps URI --> position update
  47. private Dictionary<string,AgentPosition> m_updateAgentQueue = new Dictionary<string,AgentPosition>();
  48. //private GridRegion m_Region;
  49. public SimulationServiceConnector()
  50. {
  51. }
  52. public SimulationServiceConnector(IConfigSource config)
  53. {
  54. //m_Region = region;
  55. }
  56. public IScene GetScene(UUID regionId)
  57. {
  58. return null;
  59. }
  60. public ISimulationService GetInnerService()
  61. {
  62. return null;
  63. }
  64. #region Agents
  65. protected virtual string AgentPath()
  66. {
  67. return "agent/";
  68. }
  69. protected virtual void PackData(OSDMap args, AgentCircuitData aCircuit, GridRegion destination, uint flags)
  70. {
  71. args["destination_x"] = OSD.FromString(destination.RegionLocX.ToString());
  72. args["destination_y"] = OSD.FromString(destination.RegionLocY.ToString());
  73. args["destination_name"] = OSD.FromString(destination.RegionName);
  74. args["destination_uuid"] = OSD.FromString(destination.RegionID.ToString());
  75. args["teleport_flags"] = OSD.FromString(flags.ToString());
  76. }
  77. public bool CreateAgent(GridRegion destination, AgentCircuitData aCircuit, uint flags, out string reason)
  78. {
  79. string tmp = String.Empty;
  80. return CreateAgent(destination, aCircuit, flags, out tmp, out reason);
  81. }
  82. public bool CreateAgent(GridRegion destination, AgentCircuitData aCircuit, uint flags, out string myipaddress, out string reason)
  83. {
  84. m_log.DebugFormat("[REMOTE SIMULATION CONNECTOR]: Creating agent at {0}", destination.ServerURI);
  85. reason = String.Empty;
  86. myipaddress = String.Empty;
  87. if (destination == null)
  88. {
  89. m_log.Debug("[REMOTE SIMULATION CONNECTOR]: Given destination is null");
  90. return false;
  91. }
  92. string uri = destination.ServerURI + AgentPath() + aCircuit.AgentID + "/";
  93. try
  94. {
  95. OSDMap args = aCircuit.PackAgentCircuitData();
  96. PackData(args, aCircuit, destination, flags);
  97. OSDMap result = WebUtil.PostToServiceCompressed(uri, args, 30000);
  98. bool success = result["success"].AsBoolean();
  99. if (success && result.ContainsKey("_Result"))
  100. {
  101. OSDMap data = (OSDMap)result["_Result"];
  102. reason = data["reason"].AsString();
  103. success = data["success"].AsBoolean();
  104. myipaddress = data["your_ip"].AsString();
  105. return success;
  106. }
  107. // Try the old version, uncompressed
  108. result = WebUtil.PostToService(uri, args, 30000);
  109. if (result["Success"].AsBoolean())
  110. {
  111. if (result.ContainsKey("_Result"))
  112. {
  113. OSDMap data = (OSDMap)result["_Result"];
  114. reason = data["reason"].AsString();
  115. success = data["success"].AsBoolean();
  116. myipaddress = data["your_ip"].AsString();
  117. m_log.WarnFormat(
  118. "[REMOTE SIMULATION CONNECTOR]: Remote simulator {0} did not accept compressed transfer, suggest updating it.", destination.RegionName);
  119. return success;
  120. }
  121. }
  122. m_log.WarnFormat(
  123. "[REMOTE SIMULATION CONNECTOR]: Failed to create agent {0} {1} at remote simulator {2}",
  124. aCircuit.firstname, aCircuit.lastname, destination.RegionName);
  125. reason = result["Message"] != null ? result["Message"].AsString() : "error";
  126. return false;
  127. }
  128. catch (Exception e)
  129. {
  130. m_log.Warn("[REMOTE SIMULATION CONNECTOR]: CreateAgent failed with exception: " + e.ToString());
  131. reason = e.Message;
  132. }
  133. return false;
  134. }
  135. /// <summary>
  136. /// Send complete data about an agent in this region to a neighbor
  137. /// </summary>
  138. public bool UpdateAgent(GridRegion destination, AgentData data)
  139. {
  140. return UpdateAgent(destination, (IAgentData)data, 200000); // yes, 200 seconds
  141. }
  142. private ExpiringCache<string, bool> _failedSims = new ExpiringCache<string, bool>();
  143. /// <summary>
  144. /// Send updated position information about an agent in this region to a neighbor
  145. /// This operation may be called very frequently if an avatar is moving about in
  146. /// the region.
  147. /// </summary>
  148. public bool UpdateAgent(GridRegion destination, AgentPosition data)
  149. {
  150. bool v = true;
  151. if (_failedSims.TryGetValue(destination.ServerURI, out v))
  152. return false;
  153. // The basic idea of this code is that the first thread that needs to
  154. // send an update for a specific avatar becomes the worker for any subsequent
  155. // requests until there are no more outstanding requests. Further, only send the most
  156. // recent update; this *should* never be needed but some requests get
  157. // slowed down and once that happens the problem with service end point
  158. // limits kicks in and nothing proceeds
  159. string uri = destination.ServerURI + AgentPath() + data.AgentID + "/";
  160. lock (m_updateAgentQueue)
  161. {
  162. if (m_updateAgentQueue.ContainsKey(uri))
  163. {
  164. // Another thread is already handling
  165. // updates for this simulator, just update
  166. // the position and return, overwrites are
  167. // not a problem since we only care about the
  168. // last update anyway
  169. m_updateAgentQueue[uri] = data;
  170. return true;
  171. }
  172. // Otherwise update the reference and start processing
  173. m_updateAgentQueue[uri] = data;
  174. }
  175. AgentPosition pos = null;
  176. bool success = true;
  177. while (success)
  178. {
  179. lock (m_updateAgentQueue)
  180. {
  181. // save the position
  182. AgentPosition lastpos = pos;
  183. pos = m_updateAgentQueue[uri];
  184. // this is true if no one put a new
  185. // update in the map since the last
  186. // one we processed, if thats the
  187. // case then we are done
  188. if (pos == lastpos)
  189. {
  190. m_updateAgentQueue.Remove(uri);
  191. return true;
  192. }
  193. }
  194. success = UpdateAgent(destination, (IAgentData)pos, 10000);
  195. }
  196. // we get here iff success == false
  197. // blacklist sim for 2 minutes
  198. lock (m_updateAgentQueue)
  199. {
  200. _failedSims.AddOrUpdate(destination.ServerURI, true, 120);
  201. m_updateAgentQueue.Remove(uri);
  202. }
  203. return false;
  204. }
  205. /// <summary>
  206. /// This is the worker function to send AgentData to a neighbor region
  207. /// </summary>
  208. private bool UpdateAgent(GridRegion destination, IAgentData cAgentData, int timeout)
  209. {
  210. // m_log.DebugFormat("[REMOTE SIMULATION CONNECTOR]: UpdateAgent in {0}", destination.ServerURI);
  211. // Eventually, we want to use a caps url instead of the agentID
  212. string uri = destination.ServerURI + AgentPath() + cAgentData.AgentID + "/";
  213. try
  214. {
  215. OSDMap args = cAgentData.Pack();
  216. args["destination_x"] = OSD.FromString(destination.RegionLocX.ToString());
  217. args["destination_y"] = OSD.FromString(destination.RegionLocY.ToString());
  218. args["destination_name"] = OSD.FromString(destination.RegionName);
  219. args["destination_uuid"] = OSD.FromString(destination.RegionID.ToString());
  220. OSDMap result = WebUtil.PutToServiceCompressed(uri, args, timeout);
  221. if (result["Success"].AsBoolean())
  222. return true;
  223. result = WebUtil.PutToService(uri, args, timeout);
  224. return result["Success"].AsBoolean();
  225. }
  226. catch (Exception e)
  227. {
  228. m_log.Warn("[REMOTE SIMULATION CONNECTOR]: UpdateAgent failed with exception: " + e.ToString());
  229. }
  230. return false;
  231. }
  232. /// <summary>
  233. /// </summary>
  234. public bool QueryAccess(GridRegion destination, UUID id, Vector3 position, out string version, out string reason)
  235. {
  236. reason = "Failed to contact destination";
  237. version = "Unknown";
  238. // m_log.DebugFormat("[REMOTE SIMULATION CONNECTOR]: QueryAccess start, position={0}", position);
  239. IPEndPoint ext = destination.ExternalEndPoint;
  240. if (ext == null) return false;
  241. // Eventually, we want to use a caps url instead of the agentID
  242. string uri = destination.ServerURI + AgentPath() + id + "/" + destination.RegionID.ToString() + "/";
  243. OSDMap request = new OSDMap();
  244. request.Add("position", OSD.FromString(position.ToString()));
  245. try
  246. {
  247. OSDMap result = WebUtil.ServiceOSDRequest(uri, request, "QUERYACCESS", 30000, false);
  248. bool success = result["success"].AsBoolean();
  249. if (result.ContainsKey("_Result"))
  250. {
  251. OSDMap data = (OSDMap)result["_Result"];
  252. // FIXME: If there is a _Result map then it's the success key here that indicates the true success
  253. // or failure, not the sibling result node.
  254. success = data["success"];
  255. reason = data["reason"].AsString();
  256. if (data["version"] != null && data["version"].AsString() != string.Empty)
  257. version = data["version"].AsString();
  258. m_log.DebugFormat(
  259. "[REMOTE SIMULATION CONNECTOR]: QueryAccess to {0} returned {1}, reason {2}, version {3} ({4})",
  260. uri, success, reason, version, data["version"].AsString());
  261. }
  262. if (!success)
  263. {
  264. // If we don't check this then OpenSimulator 0.7.3.1 and some period before will never see the
  265. // actual failure message
  266. if (!result.ContainsKey("_Result"))
  267. {
  268. if (result.ContainsKey("Message"))
  269. {
  270. string message = result["Message"].AsString();
  271. if (message == "Service request failed: [MethodNotAllowed] MethodNotAllowed") // Old style region
  272. {
  273. m_log.Info("[REMOTE SIMULATION CONNECTOR]: The above web util error was caused by a TP to a sim that doesn't support QUERYACCESS and can be ignored");
  274. return true;
  275. }
  276. reason = result["Message"];
  277. }
  278. else
  279. {
  280. reason = "Communications failure";
  281. }
  282. }
  283. return false;
  284. }
  285. return success;
  286. }
  287. catch (Exception e)
  288. {
  289. m_log.WarnFormat("[REMOTE SIMULATION CONNECTOR] QueryAcesss failed with exception; {0}",e.ToString());
  290. }
  291. return false;
  292. }
  293. /// <summary>
  294. /// </summary>
  295. public bool ReleaseAgent(UUID origin, UUID id, string uri)
  296. {
  297. // m_log.DebugFormat("[REMOTE SIMULATION CONNECTOR]: ReleaseAgent start");
  298. try
  299. {
  300. WebUtil.ServiceOSDRequest(uri, null, "DELETE", 10000, false);
  301. }
  302. catch (Exception e)
  303. {
  304. m_log.WarnFormat("[REMOTE SIMULATION CONNECTOR] ReleaseAgent failed with exception; {0}",e.ToString());
  305. }
  306. return true;
  307. }
  308. /// <summary>
  309. /// </summary>
  310. public bool CloseAgent(GridRegion destination, UUID id, string auth_code)
  311. {
  312. string uri = destination.ServerURI + AgentPath() + id + "/" + destination.RegionID.ToString() + "/?auth=" + auth_code;
  313. m_log.DebugFormat("[REMOTE SIMULATION CONNECTOR]: CloseAgent {0}", uri);
  314. try
  315. {
  316. WebUtil.ServiceOSDRequest(uri, null, "DELETE", 10000, false);
  317. }
  318. catch (Exception e)
  319. {
  320. m_log.WarnFormat("[REMOTE SIMULATION CONNECTOR] CloseAgent failed with exception; {0}",e.ToString());
  321. }
  322. return true;
  323. }
  324. #endregion Agents
  325. #region Objects
  326. protected virtual string ObjectPath()
  327. {
  328. return "object/";
  329. }
  330. /// <summary>
  331. ///
  332. /// </summary>
  333. public bool CreateObject(GridRegion destination, Vector3 newPosition, ISceneObject sog, bool isLocalCall)
  334. {
  335. // m_log.DebugFormat("[REMOTE SIMULATION CONNECTOR]: CreateObject start");
  336. string uri = destination.ServerURI + ObjectPath() + sog.UUID + "/";
  337. try
  338. {
  339. OSDMap args = new OSDMap(2);
  340. args["sog"] = OSD.FromString(sog.ToXml2());
  341. args["extra"] = OSD.FromString(sog.ExtraToXmlString());
  342. args["modified"] = OSD.FromBoolean(sog.HasGroupChanged);
  343. args["new_position"] = newPosition.ToString();
  344. string state = sog.GetStateSnapshot();
  345. if (state.Length > 0)
  346. args["state"] = OSD.FromString(state);
  347. // Add the input general arguments
  348. args["destination_x"] = OSD.FromString(destination.RegionLocX.ToString());
  349. args["destination_y"] = OSD.FromString(destination.RegionLocY.ToString());
  350. args["destination_name"] = OSD.FromString(destination.RegionName);
  351. args["destination_uuid"] = OSD.FromString(destination.RegionID.ToString());
  352. OSDMap result = WebUtil.PostToService(uri, args, 40000);
  353. if (result == null)
  354. return false;
  355. bool success = result["success"].AsBoolean();
  356. if (!success)
  357. return false;
  358. }
  359. catch (Exception e)
  360. {
  361. m_log.WarnFormat("[REMOTE SIMULATION CONNECTOR] CreateObject failed with exception; {0}",e.ToString());
  362. return false;
  363. }
  364. return true;
  365. }
  366. /// <summary>
  367. ///
  368. /// </summary>
  369. public bool CreateObject(GridRegion destination, UUID userID, UUID itemID)
  370. {
  371. // TODO, not that urgent
  372. return false;
  373. }
  374. #endregion Objects
  375. }
  376. }