86367d7219
This is to achieve a clean separation of concerns - the watchdog is an inappropriate place for work management. Also adds a WorkManager.RunInThreadPool() class which feeds through to Util.FireAndForget. Also switches around the name and obj arguments to the new RunInThread() and RunJob() methods so that the callback obj comes after the callback as seen in the SDK and elsewhere
455 lines
16 KiB
C#
455 lines
16 KiB
C#
/*
|
|
* 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.Reflection;
|
|
using System.Threading;
|
|
using log4net;
|
|
using Nini.Config;
|
|
using Mono.Addins;
|
|
using OpenMetaverse;
|
|
using OpenMetaverse.StructuredData;
|
|
using OpenSim.Framework;
|
|
using OpenSim.Framework.Monitoring;
|
|
using OpenSim.Framework.Servers;
|
|
using OpenSim.Framework.Servers.HttpServer;
|
|
using OpenSim.Region.Framework.Interfaces;
|
|
using OpenSim.Region.Framework.Scenes;
|
|
using OpenSim.Framework.Capabilities;
|
|
using OpenSim.Services.Interfaces;
|
|
using Caps = OpenSim.Framework.Capabilities.Caps;
|
|
using OpenSim.Capabilities.Handlers;
|
|
|
|
namespace OpenSim.Region.ClientStack.Linden
|
|
{
|
|
/// <summary>
|
|
/// This module implements both WebFetchInventoryDescendents and FetchInventoryDescendents2 capabilities.
|
|
/// </summary>
|
|
[Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "WebFetchInvDescModule")]
|
|
public class WebFetchInvDescModule : INonSharedRegionModule
|
|
{
|
|
class aPollRequest
|
|
{
|
|
public PollServiceInventoryEventArgs thepoll;
|
|
public UUID reqID;
|
|
public Hashtable request;
|
|
public ScenePresence presence;
|
|
public List<UUID> folders;
|
|
}
|
|
|
|
private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
|
|
|
|
/// <summary>
|
|
/// Control whether requests will be processed asynchronously.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Defaults to true. Can currently not be changed once a region has been added to the module.
|
|
/// </remarks>
|
|
public bool ProcessQueuedRequestsAsync { get; private set; }
|
|
|
|
/// <summary>
|
|
/// Number of inventory requests processed by this module.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// It's the PollServiceRequestManager that actually sends completed requests back to the requester.
|
|
/// </remarks>
|
|
public static int ProcessedRequestsCount { get; set; }
|
|
|
|
private static Stat s_queuedRequestsStat;
|
|
private static Stat s_processedRequestsStat;
|
|
|
|
public Scene Scene { get; private set; }
|
|
|
|
private IInventoryService m_InventoryService;
|
|
private ILibraryService m_LibraryService;
|
|
|
|
private bool m_Enabled;
|
|
|
|
private string m_fetchInventoryDescendents2Url;
|
|
private string m_webFetchInventoryDescendentsUrl;
|
|
|
|
private static WebFetchInvDescHandler m_webFetchHandler;
|
|
|
|
private static Thread[] m_workerThreads = null;
|
|
|
|
private static DoubleQueue<aPollRequest> m_queue =
|
|
new DoubleQueue<aPollRequest>();
|
|
|
|
#region ISharedRegionModule Members
|
|
|
|
public WebFetchInvDescModule() : this(true) {}
|
|
|
|
public WebFetchInvDescModule(bool processQueuedResultsAsync)
|
|
{
|
|
ProcessQueuedRequestsAsync = processQueuedResultsAsync;
|
|
}
|
|
|
|
public void Initialise(IConfigSource source)
|
|
{
|
|
IConfig config = source.Configs["ClientStack.LindenCaps"];
|
|
if (config == null)
|
|
return;
|
|
|
|
m_fetchInventoryDescendents2Url = config.GetString("Cap_FetchInventoryDescendents2", string.Empty);
|
|
m_webFetchInventoryDescendentsUrl = config.GetString("Cap_WebFetchInventoryDescendents", string.Empty);
|
|
|
|
if (m_fetchInventoryDescendents2Url != string.Empty || m_webFetchInventoryDescendentsUrl != string.Empty)
|
|
{
|
|
m_Enabled = true;
|
|
}
|
|
}
|
|
|
|
public void AddRegion(Scene s)
|
|
{
|
|
if (!m_Enabled)
|
|
return;
|
|
|
|
Scene = s;
|
|
}
|
|
|
|
public void RemoveRegion(Scene s)
|
|
{
|
|
if (!m_Enabled)
|
|
return;
|
|
|
|
Scene.EventManager.OnRegisterCaps -= RegisterCaps;
|
|
|
|
StatsManager.DeregisterStat(s_processedRequestsStat);
|
|
StatsManager.DeregisterStat(s_queuedRequestsStat);
|
|
|
|
if (ProcessQueuedRequestsAsync)
|
|
{
|
|
if (m_workerThreads != null)
|
|
{
|
|
foreach (Thread t in m_workerThreads)
|
|
Watchdog.AbortThread(t.ManagedThreadId);
|
|
|
|
m_workerThreads = null;
|
|
}
|
|
}
|
|
|
|
Scene = null;
|
|
}
|
|
|
|
public void RegionLoaded(Scene s)
|
|
{
|
|
if (!m_Enabled)
|
|
return;
|
|
|
|
if (s_processedRequestsStat == null)
|
|
s_processedRequestsStat =
|
|
new Stat(
|
|
"ProcessedFetchInventoryRequests",
|
|
"Number of processed fetch inventory requests",
|
|
"These have not necessarily yet been dispatched back to the requester.",
|
|
"",
|
|
"inventory",
|
|
"httpfetch",
|
|
StatType.Pull,
|
|
MeasuresOfInterest.AverageChangeOverTime,
|
|
stat => { stat.Value = ProcessedRequestsCount; },
|
|
StatVerbosity.Debug);
|
|
|
|
if (s_queuedRequestsStat == null)
|
|
s_queuedRequestsStat =
|
|
new Stat(
|
|
"QueuedFetchInventoryRequests",
|
|
"Number of fetch inventory requests queued for processing",
|
|
"",
|
|
"",
|
|
"inventory",
|
|
"httpfetch",
|
|
StatType.Pull,
|
|
MeasuresOfInterest.AverageChangeOverTime,
|
|
stat => { stat.Value = m_queue.Count; },
|
|
StatVerbosity.Debug);
|
|
|
|
StatsManager.RegisterStat(s_processedRequestsStat);
|
|
StatsManager.RegisterStat(s_queuedRequestsStat);
|
|
|
|
m_InventoryService = Scene.InventoryService;
|
|
m_LibraryService = Scene.LibraryService;
|
|
|
|
// We'll reuse the same handler for all requests.
|
|
m_webFetchHandler = new WebFetchInvDescHandler(m_InventoryService, m_LibraryService);
|
|
|
|
Scene.EventManager.OnRegisterCaps += RegisterCaps;
|
|
|
|
if (ProcessQueuedRequestsAsync && m_workerThreads == null)
|
|
{
|
|
m_workerThreads = new Thread[2];
|
|
|
|
for (uint i = 0; i < 2; i++)
|
|
{
|
|
m_workerThreads[i] = WorkManager.StartThread(DoInventoryRequests,
|
|
String.Format("InventoryWorkerThread{0}", i),
|
|
ThreadPriority.Normal,
|
|
false,
|
|
true,
|
|
null,
|
|
int.MaxValue);
|
|
}
|
|
}
|
|
}
|
|
|
|
public void PostInitialise()
|
|
{
|
|
}
|
|
|
|
public void Close() { }
|
|
|
|
public string Name { get { return "WebFetchInvDescModule"; } }
|
|
|
|
public Type ReplaceableInterface
|
|
{
|
|
get { return null; }
|
|
}
|
|
|
|
#endregion
|
|
|
|
private class PollServiceInventoryEventArgs : PollServiceEventArgs
|
|
{
|
|
private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
|
|
|
|
private Dictionary<UUID, Hashtable> responses =
|
|
new Dictionary<UUID, Hashtable>();
|
|
|
|
private WebFetchInvDescModule m_module;
|
|
|
|
public PollServiceInventoryEventArgs(WebFetchInvDescModule module, string url, UUID pId) :
|
|
base(null, url, null, null, null, pId, int.MaxValue)
|
|
{
|
|
m_module = module;
|
|
|
|
HasEvents = (x, y) => { lock (responses) return responses.ContainsKey(x); };
|
|
GetEvents = (x, y) =>
|
|
{
|
|
lock (responses)
|
|
{
|
|
try
|
|
{
|
|
return responses[x];
|
|
}
|
|
finally
|
|
{
|
|
responses.Remove(x);
|
|
}
|
|
}
|
|
};
|
|
|
|
Request = (x, y) =>
|
|
{
|
|
ScenePresence sp = m_module.Scene.GetScenePresence(Id);
|
|
if (sp == null)
|
|
{
|
|
m_log.ErrorFormat("[INVENTORY]: Unable to find ScenePresence for {0}", Id);
|
|
return;
|
|
}
|
|
|
|
aPollRequest reqinfo = new aPollRequest();
|
|
reqinfo.thepoll = this;
|
|
reqinfo.reqID = x;
|
|
reqinfo.request = y;
|
|
reqinfo.presence = sp;
|
|
reqinfo.folders = new List<UUID>();
|
|
|
|
// Decode the request here
|
|
string request = y["body"].ToString();
|
|
|
|
request = request.Replace("<string>00000000-0000-0000-0000-000000000000</string>", "<uuid>00000000-0000-0000-0000-000000000000</uuid>");
|
|
|
|
request = request.Replace("<key>fetch_folders</key><integer>0</integer>", "<key>fetch_folders</key><boolean>0</boolean>");
|
|
request = request.Replace("<key>fetch_folders</key><integer>1</integer>", "<key>fetch_folders</key><boolean>1</boolean>");
|
|
|
|
Hashtable hash = new Hashtable();
|
|
try
|
|
{
|
|
hash = (Hashtable)LLSD.LLSDDeserialize(Utils.StringToBytes(request));
|
|
}
|
|
catch (LLSD.LLSDParseException e)
|
|
{
|
|
m_log.ErrorFormat("[INVENTORY]: Fetch error: {0}{1}" + e.Message, e.StackTrace);
|
|
m_log.Error("Request: " + request);
|
|
return;
|
|
}
|
|
catch (System.Xml.XmlException)
|
|
{
|
|
m_log.ErrorFormat("[INVENTORY]: XML Format error");
|
|
}
|
|
|
|
ArrayList foldersrequested = (ArrayList)hash["folders"];
|
|
|
|
bool highPriority = false;
|
|
|
|
for (int i = 0; i < foldersrequested.Count; i++)
|
|
{
|
|
Hashtable inventoryhash = (Hashtable)foldersrequested[i];
|
|
string folder = inventoryhash["folder_id"].ToString();
|
|
UUID folderID;
|
|
if (UUID.TryParse(folder, out folderID))
|
|
{
|
|
if (!reqinfo.folders.Contains(folderID))
|
|
{
|
|
//TODO: Port COF handling from Avination
|
|
reqinfo.folders.Add(folderID);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (highPriority)
|
|
m_queue.EnqueueHigh(reqinfo);
|
|
else
|
|
m_queue.EnqueueLow(reqinfo);
|
|
};
|
|
|
|
NoEvents = (x, y) =>
|
|
{
|
|
/*
|
|
lock (requests)
|
|
{
|
|
Hashtable request = requests.Find(id => id["RequestID"].ToString() == x.ToString());
|
|
requests.Remove(request);
|
|
}
|
|
*/
|
|
Hashtable response = new Hashtable();
|
|
|
|
response["int_response_code"] = 500;
|
|
response["str_response_string"] = "Script timeout";
|
|
response["content_type"] = "text/plain";
|
|
response["keepalive"] = false;
|
|
response["reusecontext"] = false;
|
|
|
|
return response;
|
|
};
|
|
}
|
|
|
|
public void Process(aPollRequest requestinfo)
|
|
{
|
|
UUID requestID = requestinfo.reqID;
|
|
|
|
Hashtable response = new Hashtable();
|
|
|
|
response["int_response_code"] = 200;
|
|
response["content_type"] = "text/plain";
|
|
response["keepalive"] = false;
|
|
response["reusecontext"] = false;
|
|
|
|
response["str_response_string"] = m_webFetchHandler.FetchInventoryDescendentsRequest(
|
|
requestinfo.request["body"].ToString(), String.Empty, String.Empty, null, null);
|
|
|
|
lock (responses)
|
|
responses[requestID] = response;
|
|
|
|
WebFetchInvDescModule.ProcessedRequestsCount++;
|
|
}
|
|
}
|
|
|
|
private void RegisterCaps(UUID agentID, Caps caps)
|
|
{
|
|
RegisterFetchDescendentsCap(agentID, caps, "FetchInventoryDescendents2", m_fetchInventoryDescendents2Url);
|
|
}
|
|
|
|
private void RegisterFetchDescendentsCap(UUID agentID, Caps caps, string capName, string url)
|
|
{
|
|
string capUrl;
|
|
|
|
// disable the cap clause
|
|
if (url == "")
|
|
{
|
|
return;
|
|
}
|
|
// handled by the simulator
|
|
else if (url == "localhost")
|
|
{
|
|
capUrl = "/CAPS/" + UUID.Random() + "/";
|
|
|
|
// Register this as a poll service
|
|
PollServiceInventoryEventArgs args = new PollServiceInventoryEventArgs(this, capUrl, agentID);
|
|
args.Type = PollServiceEventArgs.EventType.Inventory;
|
|
|
|
caps.RegisterPollHandler(capName, args);
|
|
}
|
|
// external handler
|
|
else
|
|
{
|
|
capUrl = url;
|
|
IExternalCapsModule handler = Scene.RequestModuleInterface<IExternalCapsModule>();
|
|
if (handler != null)
|
|
handler.RegisterExternalUserCapsHandler(agentID,caps,capName,capUrl);
|
|
else
|
|
caps.RegisterHandler(capName, capUrl);
|
|
}
|
|
|
|
// m_log.DebugFormat(
|
|
// "[FETCH INVENTORY DESCENDENTS2 MODULE]: Registered capability {0} at {1} in region {2} for {3}",
|
|
// capName, capUrl, m_scene.RegionInfo.RegionName, agentID);
|
|
}
|
|
|
|
// private void DeregisterCaps(UUID agentID, Caps caps)
|
|
// {
|
|
// string capUrl;
|
|
//
|
|
// if (m_capsDict.TryGetValue(agentID, out capUrl))
|
|
// {
|
|
// MainServer.Instance.RemoveHTTPHandler("", capUrl);
|
|
// m_capsDict.Remove(agentID);
|
|
// }
|
|
// }
|
|
|
|
private void DoInventoryRequests()
|
|
{
|
|
while (true)
|
|
{
|
|
Watchdog.UpdateThread();
|
|
|
|
WaitProcessQueuedInventoryRequest();
|
|
}
|
|
}
|
|
|
|
public void WaitProcessQueuedInventoryRequest()
|
|
{
|
|
aPollRequest poolreq = m_queue.Dequeue();
|
|
|
|
if (poolreq != null && poolreq.thepoll != null)
|
|
{
|
|
try
|
|
{
|
|
poolreq.thepoll.Process(poolreq);
|
|
}
|
|
catch (Exception e)
|
|
{
|
|
m_log.ErrorFormat(
|
|
"[INVENTORY]: Failed to process queued inventory request {0} for {1} in {2}. Exception {3}",
|
|
poolreq.reqID, poolreq.presence != null ? poolreq.presence.Name : "unknown", Scene.Name, e);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|