/*
* 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.Collections;
using System.Collections.Generic;
using System.Collections.Concurrent;
using OpenSim.Framework.Servers;
using OpenSim.Framework.Servers.HttpServer;
using OpenMetaverse;
using OpenMetaverse.StructuredData;
namespace OpenSim.Framework.Capabilities
{
///
/// CapsHandlers is a cap handler container but also takes
/// care of adding and removing cap handlers to and from the
/// supplied BaseHttpServer.
///
public class CapsHandlers
{
private readonly Dictionary m_capsHandlers = new Dictionary();
private readonly ConcurrentDictionary m_capsSimpleHandlers = new ConcurrentDictionary();
private IHttpServer m_httpListener;
private string m_httpListenerHostName;
private uint m_httpListenerPort;
public readonly string BaseURL;
///
/// CapsHandlers is a cap handler container but also takes
/// care of adding and removing cap handlers to and from the
/// supplied BaseHttpServer.
///
/// base HTTP server
/// host name of the HTTP server
/// HTTP port
public CapsHandlers(IHttpServer httpListener, string httpListenerHostname, uint httpListenerPort)
{
m_httpListener = httpListener;
m_httpListenerHostName = httpListenerHostname;
m_httpListenerPort = httpListenerPort;
if (httpListener != null && httpListener.UseSSL)
BaseURL = $"https://{m_httpListenerHostName}:{m_httpListenerPort}";
else
BaseURL = $"http://{m_httpListenerHostName}:{m_httpListenerPort}";
}
///
/// Remove the cap handler for a capability.
///
/// name of the capability of the cap
/// handler to be removed
public void Remove(string capsName)
{
lock (m_capsHandlers)
{
if(m_capsHandlers.ContainsKey(capsName))
{
m_httpListener.RemoveStreamHandler("POST", m_capsHandlers[capsName].Path);
m_httpListener.RemoveStreamHandler("PUT", m_capsHandlers[capsName].Path);
m_httpListener.RemoveStreamHandler("GET", m_capsHandlers[capsName].Path);
m_httpListener.RemoveStreamHandler("DELETE", m_capsHandlers[capsName].Path);
m_capsHandlers.Remove(capsName);
}
}
if(m_capsSimpleHandlers.TryRemove(capsName, out ISimpleStreamHandler hdr))
{
m_httpListener.RemoveSimpleStreamHandler(hdr.Path);
}
}
public void AddSimpleHandler(string capName, ISimpleStreamHandler handler, bool addToListener = true)
{
if(ContainsCap(capName))
Remove(capName);
if(m_capsSimpleHandlers.TryAdd(capName, handler) && addToListener)
m_httpListener.AddSimpleStreamHandler(handler);
}
public bool ContainsCap(string cap)
{
lock (m_capsHandlers)
if (m_capsHandlers.ContainsKey(cap))
return true;
return m_capsSimpleHandlers.ContainsKey(cap);
}
///
/// The indexer allows us to treat the CapsHandlers object
/// in an intuitive dictionary like way.
///
///
/// The indexer will throw an exception when you try to
/// retrieve a cap handler for a cap that is not contained in
/// CapsHandlers.
///
public IRequestHandler this[string idx]
{
get
{
lock (m_capsHandlers)
return m_capsHandlers[idx];
}
set
{
lock (m_capsHandlers)
{
if (m_capsHandlers.ContainsKey(idx))
{
m_httpListener.RemoveStreamHandler("POST", m_capsHandlers[idx].Path);
m_httpListener.RemoveStreamHandler("PUT", m_capsHandlers[idx].Path);
m_httpListener.RemoveStreamHandler("GET", m_capsHandlers[idx].Path);
m_httpListener.RemoveStreamHandler("DELETE", m_capsHandlers[idx].Path);
m_capsHandlers.Remove(idx);
}
if (null == value) return;
m_capsHandlers[idx] = value;
m_httpListener.AddStreamHandler(value);
}
}
}
///
/// Return the list of cap names for which this CapsHandlers
/// object contains cap handlers.
///
public string[] Caps
{
get
{
lock (m_capsHandlers)
{
string[] __keys = new string[m_capsHandlers.Keys.Count + m_capsSimpleHandlers.Keys.Count];
m_capsHandlers.Keys.CopyTo(__keys, 0);
m_capsSimpleHandlers.Keys.CopyTo(__keys, m_capsHandlers.Keys.Count);
return __keys;
}
}
}
///
/// Return an LLSD-serializable Hashtable describing the
/// capabilities and their handler details.
///
/// If true, then exclude the seed cap.
public Hashtable GetCapsDetails(bool excludeSeed, List requestedCaps)
{
Hashtable caps = new Hashtable();
if (requestedCaps == null)
{
lock (m_capsHandlers)
{
foreach (KeyValuePair kvp in m_capsSimpleHandlers)
caps[kvp.Key] = BaseURL + kvp.Value.Path;
foreach (KeyValuePair kvp in m_capsHandlers)
caps[kvp.Key] = BaseURL + kvp.Value.Path;
}
return caps;
}
lock (m_capsHandlers)
{
for (int i = 0; i < requestedCaps.Count; ++i)
{
string capsName = requestedCaps[i];
if (excludeSeed && "SEED" == capsName)
continue;
if (m_capsSimpleHandlers.TryGetValue(capsName, out ISimpleStreamHandler shdr))
{
caps[capsName] = BaseURL + shdr.Path;
continue;
}
if (m_capsHandlers.TryGetValue(capsName, out IRequestHandler chdr))
{
caps[capsName] = BaseURL + chdr.Path;
}
}
}
return caps;
}
public Dictionary GetCapsLocalPaths()
{
Dictionary caps = new();
lock (m_capsHandlers)
{
foreach (KeyValuePair kvp in m_capsSimpleHandlers)
caps[kvp.Key] = kvp.Value.Path;
foreach (KeyValuePair kvp in m_capsHandlers)
caps[kvp.Key] = kvp.Value.Path;
}
return caps;
}
public void GetCapsDetailsLLSDxml(HashSet requestedCaps, osUTF8 sb)
{
lock (m_capsHandlers)
{
if (requestedCaps is null)
return;
foreach (string capsName in requestedCaps)
{
if (m_capsSimpleHandlers.TryGetValue(capsName, out ISimpleStreamHandler shdr))
LLSDxmlEncode2.AddElem(capsName, BaseURL + shdr.Path, sb);
else if (m_capsHandlers.TryGetValue(capsName, out IRequestHandler chdr))
LLSDxmlEncode2.AddElem(capsName, BaseURL + chdr.Path, sb);
}
}
}
///
/// Returns a copy of the dictionary of all the HTTP cap handlers
///
///
/// The dictionary copy. The key is the capability name, the value is the HTTP handler.
///
public Dictionary GetCapsHandlers()
{
lock (m_capsHandlers)
return new Dictionary(m_capsHandlers);
}
}
}