567 lines
20 KiB
C#
Executable File
567 lines
20 KiB
C#
Executable File
/*
|
|
* Copyright (c) Contributors, http://opensimulator.org/
|
|
* See CONTRIBUTORS.TXT for a full list of copyright holders.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* * Neither the name of the OpenSimulator Project nor the
|
|
* names of its contributors may be used to endorse or promote products
|
|
* derived from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
|
|
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
|
|
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
using System;
|
|
using System.Collections;
|
|
using System.Collections.Generic;
|
|
using System.Net;
|
|
using System.Reflection;
|
|
using System.Text;
|
|
using log4net;
|
|
using Nini.Config;
|
|
using Mono.Addins;
|
|
using OpenMetaverse;
|
|
using OpenMetaverse.StructuredData;
|
|
using OpenSim.Framework;
|
|
using OpenSim.Framework.Servers.HttpServer;
|
|
using OpenSim.Region.Framework.Interfaces;
|
|
using OpenSim.Region.Framework.Scenes;
|
|
using Caps=OpenSim.Framework.Capabilities.Caps;
|
|
|
|
namespace OpenSim.Region.ClientStack.Linden
|
|
{
|
|
public struct QueueItem
|
|
{
|
|
public int id;
|
|
public OSDMap body;
|
|
}
|
|
|
|
[Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "EventQueueGetModule")]
|
|
public partial class EventQueueGetModule : IEventQueue, INonSharedRegionModule
|
|
{
|
|
private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
|
|
private static string LogHeader = "[EVENT QUEUE GET MODULE]";
|
|
|
|
private const int KEEPALIVE = 60; // this could be larger now, but viewers expect it on opensim
|
|
// we need to go back to close before viwers, or we may lose data
|
|
private const int VIEWERKEEPALIVE = (KEEPALIVE - 1) * 1000; // do it shorter
|
|
|
|
/// <value>
|
|
/// Debug level.
|
|
/// </value>
|
|
public int DebugLevel { get; set; }
|
|
|
|
protected Scene m_scene;
|
|
|
|
private Dictionary<UUID, int> m_ids = new Dictionary<UUID, int>();
|
|
|
|
private Dictionary<UUID, Queue<byte[]>> queues = new Dictionary<UUID, Queue<byte[]>>();
|
|
private Dictionary<UUID, UUID> m_AvatarQueueUUIDMapping = new Dictionary<UUID, UUID>();
|
|
|
|
#region INonSharedRegionModule methods
|
|
public virtual void Initialise(IConfigSource config)
|
|
{
|
|
}
|
|
|
|
public void AddRegion(Scene scene)
|
|
{
|
|
m_scene = scene;
|
|
scene.RegisterModuleInterface<IEventQueue>(this);
|
|
|
|
scene.EventManager.OnClientClosed += ClientClosed;
|
|
scene.EventManager.OnRegisterCaps += OnRegisterCaps;
|
|
|
|
MainConsole.Instance.Commands.AddCommand(
|
|
"Debug",
|
|
false,
|
|
"debug eq",
|
|
"debug eq [0|1|2]",
|
|
"Turn on event queue debugging\n"
|
|
+ " <= 0 - turns off all event queue logging\n"
|
|
+ " >= 1 - turns on event queue setup and outgoing event logging\n"
|
|
+ " >= 2 - turns on poll notification",
|
|
HandleDebugEq);
|
|
|
|
MainConsole.Instance.Commands.AddCommand(
|
|
"Debug",
|
|
false,
|
|
"show eq",
|
|
"show eq",
|
|
"Show contents of event queues for logged in avatars. Used for debugging.",
|
|
HandleShowEq);
|
|
}
|
|
|
|
public void RemoveRegion(Scene scene)
|
|
{
|
|
if (m_scene != scene)
|
|
return;
|
|
|
|
scene.EventManager.OnClientClosed -= ClientClosed;
|
|
scene.EventManager.OnRegisterCaps -= OnRegisterCaps;
|
|
|
|
scene.UnregisterModuleInterface<IEventQueue>(this);
|
|
m_scene = null;
|
|
}
|
|
|
|
public void RegionLoaded(Scene scene)
|
|
{
|
|
}
|
|
|
|
public virtual void Close()
|
|
{
|
|
}
|
|
|
|
public virtual string Name
|
|
{
|
|
get { return "EventQueueGetModule"; }
|
|
}
|
|
|
|
public Type ReplaceableInterface
|
|
{
|
|
get { return null; }
|
|
}
|
|
|
|
#endregion
|
|
|
|
protected void HandleDebugEq(string module, string[] args)
|
|
{
|
|
int debugLevel;
|
|
|
|
if (!(args.Length == 3 && int.TryParse(args[2], out debugLevel)))
|
|
{
|
|
MainConsole.Instance.Output("Usage: debug eq [0|1|2]");
|
|
}
|
|
else
|
|
{
|
|
DebugLevel = debugLevel;
|
|
MainConsole.Instance.Output(
|
|
"Set event queue debug level to {0} in {1}", DebugLevel, m_scene.RegionInfo.RegionName);
|
|
}
|
|
}
|
|
|
|
protected void HandleShowEq(string module, string[] args)
|
|
{
|
|
MainConsole.Instance.Output("Events in Scene {0} agents queues :", m_scene.Name);
|
|
|
|
lock (queues)
|
|
{
|
|
foreach (KeyValuePair<UUID, Queue<byte[]>> kvp in queues)
|
|
{
|
|
MainConsole.Instance.Output(" {0} {1}", kvp.Key, kvp.Value.Count);
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Always returns a valid queue
|
|
/// </summary>
|
|
/// <param name="agentId"></param>
|
|
/// <returns></returns>
|
|
private Queue<byte[]> TryGetQueue(UUID agentId)
|
|
{
|
|
lock (queues)
|
|
{
|
|
Queue<byte[]> queue;
|
|
if (queues.TryGetValue(agentId, out queue))
|
|
return queue;
|
|
|
|
if (DebugLevel > 0)
|
|
m_log.DebugFormat(
|
|
"[EVENTQUEUE]: Adding new queue for agent {0} in region {1}",
|
|
agentId, m_scene.RegionInfo.RegionName);
|
|
|
|
queue = new Queue<byte[]>();
|
|
queues[agentId] = queue;
|
|
|
|
return queue;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
|
|
/// May return a null queue
|
|
/// </summary>
|
|
/// <param name="agentId"></param>
|
|
/// <returns></returns>
|
|
private Queue<byte[]> GetQueue(UUID agentId)
|
|
{
|
|
lock (queues)
|
|
{
|
|
if (queues.TryGetValue(agentId, out Queue<byte[]> queue))
|
|
return queue;
|
|
return null;
|
|
}
|
|
}
|
|
|
|
#region IEventQueue Members
|
|
//legacy
|
|
public bool Enqueue(OSD data, UUID avatarID)
|
|
{
|
|
//m_log.DebugFormat("[EVENTQUEUE]: Enqueuing event for {0} in region {1}", avatarID, m_scene.RegionInfo.RegionName);
|
|
try
|
|
{
|
|
Queue<byte[]> queue = GetQueue(avatarID);
|
|
if (queue != null)
|
|
{
|
|
byte[] evData = Util.UTF8NBGetbytes(OSDParser.SerializeLLSDInnerXmlString(data));
|
|
lock (queue)
|
|
queue.Enqueue(evData);
|
|
}
|
|
else
|
|
{
|
|
m_log.WarnFormat(
|
|
"[EVENTQUEUE]: (Enqueue) No queue found for agent {0} in region {1}",
|
|
avatarID, m_scene.Name);
|
|
}
|
|
}
|
|
catch (NullReferenceException e)
|
|
{
|
|
m_log.Error("[EVENTQUEUE] Caught exception: " + e);
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
//legacy
|
|
/*
|
|
public bool Enqueue(string ev, UUID avatarID)
|
|
{
|
|
//m_log.DebugFormat("[EVENTQUEUE]: Enqueuing event for {0} in region {1}", avatarID, m_scene.RegionInfo.RegionName);
|
|
try
|
|
{
|
|
Queue<byte[]> queue = GetQueue(avatarID);
|
|
if (queue != null)
|
|
{
|
|
byte[] evData = Util.UTF8NBGetbytes(ev);
|
|
lock (queue)
|
|
queue.Enqueue(evData);
|
|
}
|
|
else
|
|
{
|
|
m_log.WarnFormat(
|
|
"[EVENTQUEUE]: (Enqueue) No queue found for agent {0} in region {1}",
|
|
avatarID, m_scene.Name);
|
|
}
|
|
}
|
|
catch (NullReferenceException e)
|
|
{
|
|
m_log.Error("[EVENTQUEUE] Caught exception: " + e);
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
*/
|
|
|
|
public bool Enqueue(byte[] evData, UUID avatarID)
|
|
{
|
|
//m_log.DebugFormat("[EVENTQUEUE]: Enqueuing event for {0} in region {1}", avatarID, m_scene.RegionInfo.RegionName);
|
|
try
|
|
{
|
|
Queue<byte[]> queue = GetQueue(avatarID);
|
|
if (queue != null)
|
|
{
|
|
lock (queue)
|
|
queue.Enqueue(evData);
|
|
}
|
|
else
|
|
{
|
|
m_log.WarnFormat(
|
|
"[EVENTQUEUE]: (Enqueue) No queue found for agent {0} in region {1}",
|
|
avatarID, m_scene.Name);
|
|
}
|
|
}
|
|
catch (NullReferenceException e)
|
|
{
|
|
m_log.Error("[EVENTQUEUE] Caught exception: " + e);
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
#endregion
|
|
|
|
private void ClientClosed(UUID agentID, Scene scene)
|
|
{
|
|
//m_log.DebugFormat("[EVENTQUEUE]: Closed client {0} in region {1}", agentID, m_scene.RegionInfo.RegionName);
|
|
|
|
lock (queues)
|
|
{
|
|
queues.Remove(agentID);
|
|
|
|
lock (m_AvatarQueueUUIDMapping)
|
|
m_AvatarQueueUUIDMapping.Remove(agentID);
|
|
|
|
lock (m_ids)
|
|
m_ids.Remove(agentID);
|
|
}
|
|
|
|
// m_log.DebugFormat("[EVENTQUEUE]: Deleted queues for {0} in region {1}", agentID, m_scene.RegionInfo.RegionName);
|
|
|
|
}
|
|
|
|
/// <summary>
|
|
/// Generate an Event Queue Get handler path for the given eqg uuid.
|
|
/// </summary>
|
|
/// <param name='eqgUuid'></param>
|
|
private string GenerateEqgCapPath(UUID eqgUuid)
|
|
{
|
|
return string.Format("/CE/{0}/", eqgUuid);
|
|
}
|
|
|
|
public void OnRegisterCaps(UUID agentID, Caps caps)
|
|
{
|
|
// Register an event queue for the client
|
|
|
|
if (DebugLevel > 0)
|
|
m_log.DebugFormat(
|
|
"[EVENTQUEUE]: OnRegisterCaps: agentID {0} caps {1} region {2}",
|
|
agentID, caps, m_scene.RegionInfo.RegionName);
|
|
|
|
UUID eventQueueGetUUID;
|
|
Queue<Byte[]> queue = null;
|
|
|
|
lock (queues)
|
|
{
|
|
queues.TryGetValue(agentID, out queue);
|
|
|
|
if (queue == null)
|
|
{
|
|
queue = new Queue<byte[]>();
|
|
queues[agentID] = queue;
|
|
|
|
lock (m_AvatarQueueUUIDMapping)
|
|
{
|
|
eventQueueGetUUID = UUID.Random();
|
|
m_AvatarQueueUUIDMapping[agentID] = eventQueueGetUUID;
|
|
lock (m_ids)
|
|
{
|
|
if (m_ids.ContainsKey(agentID))
|
|
m_ids[agentID]++;
|
|
else
|
|
{
|
|
Random rnd = new Random(Environment.TickCount);
|
|
m_ids[agentID] = rnd.Next(30000000);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
queue.Enqueue(null);
|
|
|
|
// reuse or not to reuse
|
|
lock (m_AvatarQueueUUIDMapping)
|
|
{
|
|
// Its reuse caps path not queues those are been reused already
|
|
if (m_AvatarQueueUUIDMapping.ContainsKey(agentID))
|
|
{
|
|
m_log.DebugFormat("[EVENTQUEUE]: Found Existing UUID!");
|
|
eventQueueGetUUID = m_AvatarQueueUUIDMapping[agentID];
|
|
lock (m_ids)
|
|
{
|
|
// change to negative numbers so they are changed at end of sending first marker
|
|
// old data on a queue may be sent on a response for a new caps
|
|
// but at least will be sent with coerent IDs
|
|
if (m_ids.ContainsKey(agentID))
|
|
m_ids[agentID] = -m_ids[agentID];
|
|
else
|
|
{
|
|
Random rnd = new Random(Environment.TickCount);
|
|
m_ids[agentID] = -rnd.Next(30000000);
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
eventQueueGetUUID = UUID.Random();
|
|
m_AvatarQueueUUIDMapping[agentID] = eventQueueGetUUID;
|
|
lock (m_ids)
|
|
{
|
|
if (m_ids.ContainsKey(agentID))
|
|
m_ids[agentID]++;
|
|
else
|
|
{
|
|
Random rnd = new Random(Environment.TickCount);
|
|
m_ids.Add(agentID, rnd.Next(30000000));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
caps.RegisterPollHandler(
|
|
"EventQueueGet",
|
|
new PollServiceEventArgs(null, GenerateEqgCapPath(eventQueueGetUUID), HasEvents, GetEvents, NoEvents, Drop, agentID, VIEWERKEEPALIVE));
|
|
}
|
|
|
|
public bool HasEvents(UUID requestID, UUID agentID)
|
|
{
|
|
Queue<byte[]> queue = GetQueue(agentID);
|
|
if (queue != null)
|
|
{
|
|
lock (queue)
|
|
{
|
|
//m_log.WarnFormat("POLLED FOR EVENTS BY {0} in {1} -- {2}", agentID, m_scene.RegionInfo.RegionName, queue.Count);
|
|
return queue.Count > 0;
|
|
}
|
|
}
|
|
//m_log.WarnFormat("POLLED FOR EVENTS BY {0} unknown agent", agentID);
|
|
return true;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Logs a debug line for an outbound event queue message if appropriate.
|
|
/// </summary>
|
|
/// <param name='element'>Element containing message</param>
|
|
private void LogOutboundDebugMessage(OSD element, UUID agentId)
|
|
{
|
|
if (element is OSDMap)
|
|
{
|
|
OSDMap ev = (OSDMap)element;
|
|
m_log.DebugFormat(
|
|
"Eq OUT {0,-30} to {1,-20} {2,-20}",
|
|
ev["message"], m_scene.GetScenePresence(agentId).Name, m_scene.Name);
|
|
}
|
|
}
|
|
|
|
public void Drop(UUID requestID, UUID pAgentId)
|
|
{
|
|
// do nothing, in last case http server will do it
|
|
}
|
|
|
|
private readonly byte[] EventHeader = GenEventHeader();
|
|
|
|
private static byte[] GenEventHeader()
|
|
{
|
|
return Encoding.UTF8.GetBytes("<llsd><map><key>events</key><array>");
|
|
}
|
|
|
|
public Hashtable GetEvents(UUID requestID, UUID pAgentId)
|
|
{
|
|
if (DebugLevel >= 2)
|
|
m_log.WarnFormat("POLLED FOR EQ MESSAGES BY {0} in {1}", pAgentId, m_scene.Name);
|
|
|
|
Queue<byte[]> queue = GetQueue(pAgentId);
|
|
if (queue == null)
|
|
return NoAgent(requestID, pAgentId);
|
|
|
|
byte[] element = null;
|
|
List<byte[]> elements;
|
|
|
|
int totalSize = 0;
|
|
int thisID = 0;
|
|
bool negativeID = false;
|
|
|
|
lock (queue)
|
|
{
|
|
if (queue.Count == 0)
|
|
return NoEvents(requestID, pAgentId);
|
|
|
|
lock (m_ids)
|
|
thisID = m_ids[pAgentId];
|
|
|
|
if (thisID < 0)
|
|
{
|
|
negativeID = true;
|
|
thisID = -thisID;
|
|
}
|
|
|
|
elements = new List<byte[]>(queue.Count + 2);
|
|
elements.Add(EventHeader);
|
|
|
|
while (queue.Count > 0)
|
|
{
|
|
element = queue.Dequeue();
|
|
// add elements until a marker is found
|
|
// so they get into a response
|
|
if (element == null)
|
|
break;
|
|
|
|
if (DebugLevel > 0)
|
|
LogOutboundDebugMessage(element, pAgentId);
|
|
|
|
elements.Add(element);
|
|
totalSize += element.Length;
|
|
}
|
|
}
|
|
|
|
lock (m_ids)
|
|
{
|
|
if (element == null && negativeID)
|
|
{
|
|
Random rnd = new Random(Environment.TickCount);
|
|
m_ids[pAgentId] = rnd.Next(30000000);
|
|
}
|
|
else
|
|
m_ids[pAgentId] = thisID + 1;
|
|
}
|
|
|
|
if (totalSize == 0)
|
|
return NoEvents(requestID, pAgentId);
|
|
|
|
totalSize += EventHeader.Length;
|
|
|
|
StringBuilder sb = new StringBuilder();
|
|
LLSDxmlEncode.AddEndArray(sb); // events array
|
|
LLSDxmlEncode.AddElem("id", thisID, sb);
|
|
LLSDxmlEncode.AddEndMap(sb);
|
|
element = Encoding.UTF8.GetBytes(LLSDxmlEncode.End(sb));
|
|
elements.Add(element);
|
|
totalSize += element.Length;
|
|
|
|
Hashtable responsedata = new Hashtable();
|
|
responsedata["int_response_code"] = 200;
|
|
responsedata["content_type"] = "application/xml";
|
|
|
|
//temporary
|
|
byte[] finalData = new byte[totalSize];
|
|
int dst = 0;
|
|
foreach(byte[] src in elements)
|
|
{
|
|
Array.Copy(src, 0, finalData, dst, src.Length);
|
|
dst += src.Length;
|
|
}
|
|
|
|
responsedata["bin_response_data"] = finalData;
|
|
responsedata["keepaliveTimeout"] = KEEPALIVE;
|
|
|
|
return responsedata;
|
|
}
|
|
|
|
public Hashtable NoEvents(UUID requestID, UUID agentID)
|
|
{
|
|
Hashtable responsedata = new Hashtable();
|
|
Queue<byte[]> queue = GetQueue(agentID);
|
|
if (queue == null)
|
|
{
|
|
responsedata["int_response_code"] = (int)HttpStatusCode.NotFound;
|
|
return responsedata;
|
|
}
|
|
responsedata["int_response_code"] = (int)HttpStatusCode.BadGateway;
|
|
return responsedata;
|
|
}
|
|
|
|
public Hashtable NoAgent(UUID requestID, UUID agentID)
|
|
{
|
|
Hashtable responsedata = new Hashtable();
|
|
responsedata["int_response_code"] = (int)HttpStatusCode.NotFound;
|
|
return responsedata;
|
|
}
|
|
}
|
|
}
|