123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770 |
- /*
- * 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.Generic;
- using System.Collections;
- using System.Reflection;
- using System.Net;
- using System.Net.Sockets;
- using log4net;
- using Mono.Addins;
- using Nini.Config;
- using OpenMetaverse;
- using OpenSim.Framework;
- using OpenSim.Framework.Servers;
- using OpenSim.Framework.Servers.HttpServer;
- using OpenSim.Region.Framework.Interfaces;
- using OpenSim.Region.Framework.Scenes;
- namespace OpenSim.Region.CoreModules.Scripting.LSLHttp
- {
- public class UrlData
- {
- public UUID hostID;
- public UUID itemID;
- public IScriptModule engine;
- public string url;
- public UUID urlcode;
- public Dictionary<UUID, RequestData> requests;
- public bool isSsl;
- public Scene scene;
- public bool allowXss;
- }
- public class RequestData
- {
- public UUID requestID;
- public Dictionary<string, string> headers;
- public string body;
- public int responseCode;
- public string responseBody;
- public string responseType = "text/plain";
- //public ManualResetEvent ev;
- public bool requestDone;
- public int startTime;
- public bool responseSent;
- public string uri;
- public UUID hostID;
- public Scene scene;
- }
- /// <summary>
- /// This module provides external URLs for in-world scripts.
- /// </summary>
- [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "UrlModule")]
- public class UrlModule : ISharedRegionModule, IUrlModule
- {
- private static readonly ILog m_log =
- LogManager.GetLogger(
- MethodBase.GetCurrentMethod().DeclaringType);
- protected Dictionary<UUID, UrlData> m_RequestMap =
- new Dictionary<UUID, UrlData>();
- protected Dictionary<string, UrlData> m_UrlMap =
- new Dictionary<string, UrlData>();
- protected bool m_enabled = false;
- protected string m_ErrorStr;
- protected uint m_HttpsPort = 0;
- protected IHttpServer m_HttpServer = null;
- protected IHttpServer m_HttpsServer = null;
- public string ExternalHostNameForLSL { get; protected set; }
- /// <summary>
- /// The default maximum number of urls
- /// </summary>
- public const int DefaultTotalUrls = 15000;
- /// <summary>
- /// Maximum number of external urls that can be set up by this module.
- /// </summary>
- public int TotalUrls { get; set; }
- public Type ReplaceableInterface
- {
- get { return typeof(IUrlModule); }
- }
- public string Name
- {
- get { return "UrlModule"; }
- }
- public void Initialise(IConfigSource config)
- {
- IConfig networkConfig = config.Configs["Network"];
- m_enabled = false;
- if (networkConfig != null)
- {
- ExternalHostNameForLSL = config.Configs["Network"].GetString("ExternalHostNameForLSL", null);
- bool ssl_enabled = config.Configs["Network"].GetBoolean("https_listener", false);
- if (ssl_enabled)
- m_HttpsPort = (uint)config.Configs["Network"].GetInt("https_port", (int)m_HttpsPort);
- }
- else
- {
- m_ErrorStr = "[Network] configuration missing, HTTP listener for LSL disabled";
- m_log.Warn("[URL MODULE]: " + m_ErrorStr);
- return;
- }
- if (String.IsNullOrWhiteSpace(ExternalHostNameForLSL))
- {
- m_ErrorStr = "ExternalHostNameForLSL not defined in configuration, HTTP listener for LSL disabled";
- m_log.Warn("[URL MODULE]: " + m_ErrorStr);
- return;
- }
- IPAddress ia = null;
- ia = Util.GetHostFromDNS(ExternalHostNameForLSL);
- if (ia == null)
- {
- m_ErrorStr = "Could not resolve ExternalHostNameForLSL, HTTP listener for LSL disabled";
- m_log.Warn("[URL MODULE]: " + m_ErrorStr);
- return;
- }
- m_enabled = true;
- m_ErrorStr = String.Empty;
- IConfig llFunctionsConfig = config.Configs["LL-Functions"];
- if (llFunctionsConfig != null)
- TotalUrls = llFunctionsConfig.GetInt("max_external_urls_per_simulator", DefaultTotalUrls);
- else
- TotalUrls = DefaultTotalUrls;
- }
- public void PostInitialise()
- {
- }
- public void AddRegion(Scene scene)
- {
- if (m_enabled && m_HttpServer == null)
- {
- // There can only be one
- //
- m_HttpServer = MainServer.Instance;
- //
- // We can use the https if it is enabled
- if (m_HttpsPort > 0)
- {
- m_HttpsServer = MainServer.GetHttpServer(m_HttpsPort);
- }
- }
- scene.RegisterModuleInterface<IUrlModule>(this);
- scene.EventManager.OnScriptReset += OnScriptReset;
- }
- public void RegionLoaded(Scene scene)
- {
- IScriptModule[] scriptModules = scene.RequestModuleInterfaces<IScriptModule>();
- foreach (IScriptModule scriptModule in scriptModules)
- {
- scriptModule.OnScriptRemoved += ScriptRemoved;
- scriptModule.OnObjectRemoved += ObjectRemoved;
- }
- }
- public void RemoveRegion(Scene scene)
- {
- // Drop references to that scene
- foreach (KeyValuePair<string, UrlData> kvp in m_UrlMap)
- {
- if (kvp.Value.scene == scene)
- kvp.Value.scene = null;
- }
- foreach (KeyValuePair<UUID, UrlData> kvp in m_RequestMap)
- {
- if (kvp.Value.scene == scene)
- kvp.Value.scene = null;
- }
- }
- public void Close()
- {
- }
- public UUID RequestURL(IScriptModule engine, SceneObjectPart host, UUID itemID, Hashtable options)
- {
- UUID urlcode = UUID.Random();
- if(!m_enabled)
- {
- engine.PostScriptEvent(itemID, "http_request", new Object[] { urlcode.ToString(), "URL_REQUEST_DENIED", m_ErrorStr });
- return urlcode;
- }
- lock (m_UrlMap)
- {
- if (m_UrlMap.Count >= TotalUrls)
- {
- engine.PostScriptEvent(itemID, "http_request", new Object[] { urlcode.ToString(), "URL_REQUEST_DENIED",
- "Too many URLs already open" });
- return urlcode;
- }
- string url = "http://" + ExternalHostNameForLSL + ":" + m_HttpServer.Port.ToString() + "/lslhttp/" + urlcode.ToString() + "/";
- UrlData urlData = new UrlData();
- urlData.hostID = host.UUID;
- urlData.itemID = itemID;
- urlData.engine = engine;
- urlData.url = url;
- urlData.urlcode = urlcode;
- urlData.isSsl = false;
- urlData.requests = new Dictionary<UUID, RequestData>();
- urlData.scene = host.ParentGroup.Scene;
- urlData.allowXss = false;
- if (options != null && options["allowXss"] != null)
- urlData.allowXss = true;
- m_UrlMap[url] = urlData;
- string uri = "/lslhttp/" + urlcode.ToString() + "/";
- PollServiceEventArgs args
- = new PollServiceEventArgs(HttpRequestHandler, uri, HasEvents, GetEvents, NoEvents, Drop, urlcode, 25000);
- args.Type = PollServiceEventArgs.EventType.LslHttp;
- m_HttpServer.AddPollServiceHTTPHandler(uri, args);
- // m_log.DebugFormat(
- // "[URL MODULE]: Set up incoming request url {0} for {1} in {2} {3}",
- // uri, itemID, host.Name, host.LocalId);
- engine.PostScriptEvent(itemID, "http_request", new Object[] { urlcode.ToString(), "URL_REQUEST_GRANTED", url });
- }
- return urlcode;
- }
- public UUID RequestSecureURL(IScriptModule engine, SceneObjectPart host, UUID itemID, Hashtable options)
- {
- UUID urlcode = UUID.Random();
- if(!m_enabled)
- {
- engine.PostScriptEvent(itemID, "http_request", new Object[] { urlcode.ToString(), "URL_REQUEST_DENIED", m_ErrorStr });
- return urlcode;
- }
- if (m_HttpsServer == null)
- {
- engine.PostScriptEvent(itemID, "http_request", new Object[] { urlcode.ToString(), "URL_REQUEST_DENIED", "" });
- return urlcode;
- }
- lock (m_UrlMap)
- {
- if (m_UrlMap.Count >= TotalUrls)
- {
- engine.PostScriptEvent(itemID, "http_request", new Object[] { urlcode.ToString(), "URL_REQUEST_DENIED",
- "Too many URLs already open" });
- return urlcode;
- }
- string url = "https://" + ExternalHostNameForLSL + ":" + m_HttpsServer.Port.ToString() + "/lslhttps/" + urlcode.ToString() + "/";
- UrlData urlData = new UrlData();
- urlData.hostID = host.UUID;
- urlData.itemID = itemID;
- urlData.engine = engine;
- urlData.url = url;
- urlData.urlcode = urlcode;
- urlData.isSsl = true;
- urlData.requests = new Dictionary<UUID, RequestData>();
- urlData.allowXss = false;
- if (options != null && options["allowXss"] != null)
- urlData.allowXss = true;
- m_UrlMap[url] = urlData;
- string uri = "/lslhttps/" + urlcode.ToString() + "/";
- PollServiceEventArgs args
- = new PollServiceEventArgs(HttpRequestHandler, uri, HasEvents, GetEvents, NoEvents, Drop, urlcode, 25000);
- args.Type = PollServiceEventArgs.EventType.LslHttp;
- m_HttpsServer.AddPollServiceHTTPHandler(uri, args);
- // m_log.DebugFormat(
- // "[URL MODULE]: Set up incoming secure request url {0} for {1} in {2} {3}",
- // uri, itemID, host.Name, host.LocalId);
- engine.PostScriptEvent(itemID, "http_request", new Object[] { urlcode.ToString(), "URL_REQUEST_GRANTED", url });
- }
- return urlcode;
- }
- public void ReleaseURL(string url)
- {
- lock (m_UrlMap)
- {
- UrlData data;
- if (!m_UrlMap.TryGetValue(url, out data))
- {
- return;
- }
- lock (m_RequestMap)
- {
- foreach (UUID req in data.requests.Keys)
- m_RequestMap.Remove(req);
- }
- // m_log.DebugFormat(
- // "[URL MODULE]: Releasing url {0} for {1} in {2}",
- // url, data.itemID, data.hostID);
- RemoveUrl(data);
- m_UrlMap.Remove(url);
- }
- }
- public void HttpContentType(UUID request, string type)
- {
- lock (m_UrlMap)
- {
- if (m_RequestMap.ContainsKey(request))
- {
- UrlData urlData = m_RequestMap[request];
- urlData.requests[request].responseType = type;
- }
- else
- {
- m_log.Info("[HttpRequestHandler] There is no http-in request with id " + request.ToString());
- }
- }
- }
- public void HttpResponse(UUID request, int status, string body)
- {
- lock (m_RequestMap)
- {
- if (m_RequestMap.ContainsKey(request))
- {
- UrlData urlData = m_RequestMap[request];
- if (!urlData.requests[request].responseSent)
- {
- string responseBody = body;
- if (urlData.requests[request].responseType.Equals("text/plain"))
- {
- string value;
- if (urlData.requests[request].headers.TryGetValue("user-agent", out value))
- {
- if (value != null && value.IndexOf("MSIE") >= 0)
- {
- // wrap the html escaped response if the target client is IE
- // It ignores "text/plain" if the body is html
- responseBody = "<html>" + System.Web.HttpUtility.HtmlEncode(body) + "</html>";
- }
- }
- }
- urlData.requests[request].responseCode = status;
- urlData.requests[request].responseBody = responseBody;
- //urlData.requests[request].ev.Set();
- urlData.requests[request].requestDone = true;
- urlData.requests[request].responseSent = true;
- }
- }
- else
- {
- m_log.Info("[HttpRequestHandler] There is no http-in request with id " + request.ToString());
- }
- }
- }
- public string GetHttpHeader(UUID requestId, string header)
- {
- lock (m_RequestMap)
- {
- if (m_RequestMap.ContainsKey(requestId))
- {
- UrlData urlData = m_RequestMap[requestId];
- string value;
- if (urlData.requests[requestId].headers.TryGetValue(header, out value))
- return value;
- }
- else
- {
- m_log.Warn("[HttpRequestHandler] There was no http-in request with id " + requestId);
- }
- }
- return String.Empty;
- }
- public int GetFreeUrls()
- {
- lock (m_UrlMap)
- return TotalUrls - m_UrlMap.Count;
- }
- public void ScriptRemoved(UUID itemID)
- {
- // m_log.DebugFormat("[URL MODULE]: Removing script {0}", itemID);
- lock (m_UrlMap)
- {
- List<string> removeURLs = new List<string>();
- foreach (KeyValuePair<string, UrlData> url in m_UrlMap)
- {
- if (url.Value.itemID == itemID)
- {
- RemoveUrl(url.Value);
- removeURLs.Add(url.Key);
- lock (m_RequestMap)
- {
- foreach (UUID req in url.Value.requests.Keys)
- m_RequestMap.Remove(req);
- }
- }
- }
- foreach (string urlname in removeURLs)
- m_UrlMap.Remove(urlname);
- }
- }
- public void ObjectRemoved(UUID objectID)
- {
- lock (m_UrlMap)
- {
- List<string> removeURLs = new List<string>();
- foreach (KeyValuePair<string, UrlData> url in m_UrlMap)
- {
- if (url.Value.hostID == objectID)
- {
- RemoveUrl(url.Value);
- removeURLs.Add(url.Key);
- lock (m_RequestMap)
- {
- foreach (UUID req in url.Value.requests.Keys)
- m_RequestMap.Remove(req);
- }
- }
- }
- foreach (string urlname in removeURLs)
- m_UrlMap.Remove(urlname);
- }
- }
- protected void RemoveUrl(UrlData data)
- {
- if (data.isSsl)
- m_HttpsServer.RemovePollServiceHTTPHandler("", "/lslhttps/"+data.urlcode.ToString()+"/");
- else
- m_HttpServer.RemovePollServiceHTTPHandler("", "/lslhttp/"+data.urlcode.ToString()+"/");
- }
- protected Hashtable NoEvents(UUID requestID, UUID sessionID)
- {
- Hashtable response = new Hashtable();
- UrlData url;
- int startTime = 0;
- lock (m_RequestMap)
- {
- if (!m_RequestMap.ContainsKey(requestID))
- return response;
- url = m_RequestMap[requestID];
- startTime = url.requests[requestID].startTime;
- }
- if (System.Environment.TickCount - startTime > 25000)
- {
- response["int_response_code"] = 500;
- response["str_response_string"] = "Script timeout";
- response["content_type"] = "text/plain";
- response["keepalive"] = false;
- //remove from map
- lock (url.requests)
- {
- url.requests.Remove(requestID);
- }
- lock (m_RequestMap)
- {
- m_RequestMap.Remove(requestID);
- }
- return response;
- }
- return response;
- }
- protected bool HasEvents(UUID requestID, UUID sessionID)
- {
- UrlData url=null;
- lock (m_RequestMap)
- {
- if (!m_RequestMap.ContainsKey(requestID))
- {
- return false;
- }
- url = m_RequestMap[requestID];
- }
- lock (url.requests)
- {
- if (!url.requests.ContainsKey(requestID))
- {
- return false;
- }
- else
- {
- if (System.Environment.TickCount - url.requests[requestID].startTime > 25000)
- {
- return true;
- }
- if (url.requests[requestID].requestDone)
- return true;
- else
- return false;
- }
- }
- }
- protected void Drop(UUID requestID, UUID sessionID)
- {
- UrlData url = null;
- lock (m_RequestMap)
- {
- if (m_RequestMap.ContainsKey(requestID))
- {
- url = m_RequestMap[requestID];
- m_RequestMap.Remove(requestID);
- if(url != null)
- {
- lock (url.requests)
- {
- if(url.requests.ContainsKey(requestID))
- url.requests.Remove(requestID);
- }
- }
- }
- }
- }
- protected Hashtable GetEvents(UUID requestID, UUID sessionID)
- {
- UrlData url = null;
- RequestData requestData = null;
- lock (m_RequestMap)
- {
- if (!m_RequestMap.ContainsKey(requestID))
- return NoEvents(requestID,sessionID);
- url = m_RequestMap[requestID];
- }
- lock (url.requests)
- {
- requestData = url.requests[requestID];
- }
- if (!requestData.requestDone)
- return NoEvents(requestID,sessionID);
- Hashtable response = new Hashtable();
- if (System.Environment.TickCount - requestData.startTime > 25000)
- {
- response["int_response_code"] = 500;
- response["str_response_string"] = "Script timeout";
- response["content_type"] = "text/plain";
- response["keepalive"] = false;
- return response;
- }
- //put response
- response["int_response_code"] = requestData.responseCode;
- response["str_response_string"] = requestData.responseBody;
- response["content_type"] = requestData.responseType;
- response["keepalive"] = false;
- if (url.allowXss)
- response["access_control_allow_origin"] = "*";
- //remove from map
- lock (url.requests)
- {
- url.requests.Remove(requestID);
- }
- lock (m_RequestMap)
- {
- m_RequestMap.Remove(requestID);
- }
- return response;
- }
- public void HttpRequestHandler(UUID requestID, Hashtable request)
- {
- lock (request)
- {
- string uri = request["uri"].ToString();
- bool is_ssl = uri.Contains("lslhttps");
- try
- {
- Hashtable headers = (Hashtable)request["headers"];
- // string uri_full = "http://" + ExternalHostNameForLSL + ":" + m_HttpServer.Port.ToString() + uri;// "/lslhttp/" + urlcode.ToString() + "/";
- int pos1 = uri.IndexOf("/");// /lslhttp
- int pos2 = uri.IndexOf("/", pos1 + 1);// /lslhttp/
- int pos3 = uri.IndexOf("/", pos2 + 1); // /lslhttp/urlcode
- string uri_tmp = uri.Substring(0, pos3 + 1);
- //HTTP server code doesn't provide us with QueryStrings
- string pathInfo;
- string queryString;
- queryString = "";
- pathInfo = uri.Substring(pos3);
- UrlData url = null;
- string urlkey;
- if (!is_ssl)
- urlkey = "http://" + ExternalHostNameForLSL + ":" + m_HttpServer.Port.ToString() + uri_tmp;
- //m_UrlMap[];
- else
- urlkey = "https://" + ExternalHostNameForLSL + ":" + m_HttpsServer.Port.ToString() + uri_tmp;
- if (m_UrlMap.ContainsKey(urlkey))
- {
- url = m_UrlMap[urlkey];
- }
- else
- {
- //m_log.Warn("[HttpRequestHandler]: http-in request failed; no such url: "+urlkey.ToString());
- return;
- }
- //for llGetHttpHeader support we need to store original URI here
- //to make x-path-info / x-query-string / x-script-url / x-remote-ip headers
- //as per http://wiki.secondlife.com/wiki/LlGetHTTPHeader
- RequestData requestData = new RequestData();
- requestData.requestID = requestID;
- requestData.requestDone = false;
- requestData.startTime = System.Environment.TickCount;
- requestData.uri = uri;
- requestData.hostID = url.hostID;
- requestData.scene = url.scene;
- if (requestData.headers == null)
- requestData.headers = new Dictionary<string, string>();
- foreach (DictionaryEntry header in headers)
- {
- string key = (string)header.Key;
- string value = (string)header.Value;
- requestData.headers.Add(key, value);
- }
- foreach (DictionaryEntry de in request)
- {
- if (de.Key.ToString() == "querystringkeys")
- {
- System.String[] keys = (System.String[])de.Value;
- foreach (String key in keys)
- {
- if (request.ContainsKey(key))
- {
- string val = (String)request[key];
- if (key != "")
- {
- queryString = queryString + key + "=" + val + "&";
- }
- else
- {
- queryString = queryString + val + "&";
- }
- }
- }
- if (queryString.Length > 1)
- queryString = queryString.Substring(0, queryString.Length - 1);
- }
- }
- //if this machine is behind DNAT/port forwarding, currently this is being
- //set to address of port forwarding router
- requestData.headers["x-remote-ip"] = requestData.headers["remote_addr"];
- requestData.headers["x-path-info"] = pathInfo;
- requestData.headers["x-query-string"] = queryString;
- requestData.headers["x-script-url"] = url.url;
- //requestData.ev = new ManualResetEvent(false);
- lock (url.requests)
- {
- url.requests.Add(requestID, requestData);
- }
- lock (m_RequestMap)
- {
- //add to request map
- m_RequestMap.Add(requestID, url);
- }
- url.engine.PostScriptEvent(url.itemID, "http_request", new Object[] { requestID.ToString(), request["http-method"].ToString(), request["body"].ToString() });
- //send initial response?
- // Hashtable response = new Hashtable();
- return;
- }
- catch (Exception we)
- {
- //Hashtable response = new Hashtable();
- m_log.Warn("[HttpRequestHandler]: http-in request failed");
- m_log.Warn(we.Message);
- m_log.Warn(we.StackTrace);
- }
- }
- }
- protected void OnScriptReset(uint localID, UUID itemID)
- {
- ScriptRemoved(itemID);
- }
- }
- }
|