Files
opensim/OpenSim/Server/Handlers/Grid/GridInfoHandlers.cs

229 lines
9.0 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.Net;
using System.Reflection;
using System.Security;
using log4net;
using Nini.Config;
using Nwc.XmlRpc;
using OpenSim.Framework;
using OpenSim.Framework.Servers.HttpServer;
using OpenMetaverse;
using OpenMetaverse.StructuredData;
namespace OpenSim.Server.Handlers.Grid
{
public class GridInfoHandlers
{
private static readonly ILog _log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
private IConfigSource m_Config;
private Dictionary<string, string> _info = new Dictionary<string, string>();
private byte[] cachedJsonAnswer = null;
private byte[] cachedRestAnswer = null;
/// <summary>
/// Instantiate a GridInfoService object.
/// </summary>
/// <param name="configPath">path to config path containing
/// grid information</param>
/// <remarks>
/// GridInfoService uses the [GridInfo] section of the
/// standard OpenSim.ini file --- which is not optimal, but
/// anything else requires a general redesign of the config
/// system.
/// </remarks>
public GridInfoHandlers(IConfigSource configSource)
{
m_Config = configSource;
loadGridInfo(configSource);
}
private void loadGridInfo(IConfigSource configSource)
{
_info["platform"] = "OpenSim";
try
{
IConfig gridCfg = configSource.Configs["GridInfoService"];
if (gridCfg != null)
{
foreach (string k in gridCfg.GetKeys())
_info[k] = gridCfg.GetString(k);
}
else
{
IConfig netCfg = configSource.Configs["Network"];
if (netCfg != null)
{
_info["login"] = string.Format("http://127.0.0.1:{0}/",
netCfg.GetString("http_listener_port", ConfigSettings.DefaultRegionHttpPort.ToString()));
}
else
{
_info["login"] = "http://127.0.0.1:9000/";
}
IssueWarning();
}
_info.TryGetValue("home", out string tmp);
tmp = Util.GetConfigVarFromSections<string>(m_Config, "HomeURI",
new string[] { "Startup", "Hypergrid" }, tmp);
if (string.IsNullOrEmpty(tmp))
{
IConfig logincfg = m_Config.Configs["LoginService"];
if (logincfg != null)
tmp = logincfg.GetString("SRV_HomeURI", tmp);
}
if (!string.IsNullOrEmpty(tmp))
_info["home"] = OSD.FromString(tmp);
tmp = Util.GetConfigVarFromSections<string>(m_Config, "HomeURIAlias",
new string[] { "Startup", "Hypergrid" }, string.Empty);
if (!string.IsNullOrEmpty(tmp))
_info["homealias"] = OSD.FromString(tmp);
_info.TryGetValue("gatekeeper", out tmp);
tmp = Util.GetConfigVarFromSections<string>(m_Config, "GatekeeperURI",
new string[] { "Startup", "Hypergrid" }, tmp);
if (!string.IsNullOrEmpty(tmp))
_info["gatekeeper"] = OSD.FromString(tmp);
tmp = Util.GetConfigVarFromSections<string>(m_Config, "GatekeeperURIAlias",
new string[] { "Startup", "Hypergrid" }, string.Empty);
if (!string.IsNullOrEmpty(tmp))
_info["gatekeeperalias"] = OSD.FromString(tmp);
}
catch (Exception)
{
_log.Warn("[GRID INFO SERVICE]: Cannot get grid info from config source, using minimal defaults");
}
_log.DebugFormat("[GRID INFO SERVICE]: Grid info service initialized with {0} keys", _info.Count);
}
private void IssueWarning()
{
_log.Warn("[GRID INFO SERVICE]: found no [GridInfoService] section in your configuration files");
_log.Warn("[GRID INFO SERVICE]: trying to guess sensible defaults, you might want to provide better ones:");
foreach (string k in _info.Keys)
{
_log.WarnFormat("[GRID INFO SERVICE]: {0}: {1}", k, _info[k]);
}
}
public XmlRpcResponse XmlRpcGridInfoMethod(XmlRpcRequest request, IPEndPoint remoteClient)
{
XmlRpcResponse response = new XmlRpcResponse();
Hashtable responseData = new Hashtable();
_log.Debug("[GRID INFO SERVICE]: Request for grid info");
foreach (KeyValuePair<string, string> k in _info)
{
responseData[k.Key] = k.Value;
}
response.Value = responseData;
return response;
}
public void RestGetGridInfoMethod(IOSHttpRequest httpRequest, IOSHttpResponse httpResponse)
{
httpResponse.KeepAlive = false;
if (httpRequest.HttpMethod != "GET")
{
httpResponse.StatusCode = (int)HttpStatusCode.MethodNotAllowed;
return;
}
if(cachedRestAnswer == null)
{
osUTF8 osb = OSUTF8Cached.Acquire();
osb.AppendASCII("<gridinfo>");
foreach (KeyValuePair<string, string> k in _info)
{
osb.AppendASCII('<');
osb.AppendASCII(k.Key);
osb.AppendASCII('>');
osb.AppendASCII(SecurityElement.Escape(k.Value.ToString()));
osb.AppendASCII("</");
osb.AppendASCII(k.Key);
osb.AppendASCII('>');
}
osb.AppendASCII("</gridinfo>");
cachedRestAnswer = OSUTF8Cached.GetArrayAndRelease(osb);
}
httpResponse.ContentType = "application/xml";
httpResponse.RawBuffer = cachedRestAnswer;
}
/// <summary>
/// Get GridInfo in json format: Used by the OSSL osGetGrid*
/// Adding the SRV_HomeURI to the kvp returned for use in scripts
/// </summary>
/// <returns>
/// json string
/// </returns>
/// </param>
/// <param name='httpRequest'>
/// Http request.
/// </param>
/// <param name='httpResponse'>
/// Http response.
/// </param>
public void JsonGetGridInfoMethod(IOSHttpRequest httpRequest, IOSHttpResponse httpResponse)
{
httpResponse.KeepAlive = false;
if (httpRequest.HttpMethod != "GET")
{
httpResponse.StatusCode = (int)HttpStatusCode.MethodNotAllowed;
return;
}
if (cachedJsonAnswer == null)
{
OSDMap map = new OSDMap();
foreach (KeyValuePair<string, string> k in _info)
{
map[k.Key] = OSD.FromString(k.Value.ToString());
}
cachedJsonAnswer = OSDParser.SerializeJsonToBytes(map);
}
httpResponse.ContentType = "application/json";
httpResponse.RawBuffer = cachedJsonAnswer;
}
}
}