/* * 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 OpenSim 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. */ // #define DEBUGGING using System; using System.Collections.Generic; using System.Collections.Specialized; using System.Diagnostics; using System.IO; using System.Net; using System.Reflection; using System.Text.RegularExpressions; using System.Threading; using log4net; using HttpServer; namespace OpenSim.Framework.Servers { /// /// An OSHttpRequestPump fetches incoming OSHttpRequest objects /// from the OSHttpRequestQueue and feeds them to all subscribed /// parties. Each OSHttpRequestPump encapsulates one thread to do /// the work and there is a fixed number of pumps for each /// OSHttpServer object. /// public class OSHttpRequestPump { private static readonly ILog _log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); protected OSHttpServer _server; protected OSHttpRequestQueue _queue; protected Thread _engine; private int _id; public string EngineID { get { return String.Format("{0} pump {1}", _server.EngineID, _id); } } public OSHttpRequestPump(OSHttpServer server, OSHttpRequestQueue queue, int id) { _server = server; _queue = queue; _id = id; _engine = new Thread(new ThreadStart(Engine)); _engine.Name = EngineID; _engine.IsBackground = true; _engine.Start(); ThreadTracker.Add(_engine); } public static OSHttpRequestPump[] Pumps(OSHttpServer server, OSHttpRequestQueue queue, int poolSize) { OSHttpRequestPump[] pumps = new OSHttpRequestPump[poolSize]; for (int i = 0; i < pumps.Length; i++) { pumps[i] = new OSHttpRequestPump(server, queue, i); } return pumps; } public void Start() { _engine = new Thread(new ThreadStart(Engine)); _engine.Name = EngineID; _engine.IsBackground = true; _engine.Start(); ThreadTracker.Add(_engine); } public void Engine() { OSHttpRequest req = null; while (true) { try { // dequeue an OSHttpRequest from OSHttpServer's // request queue req = _queue.Dequeue(); // get a copy of the list of registered handlers List handlers = _server.OSHttpHandlers; // prune list and have it sorted from most // specific to least specific handlers = MatchHandlers(req, handlers); // process req: we try each handler in turn until // we are either out of handlers or get back a // Pass or Done OSHttpHandlerResult rc = OSHttpHandlerResult.Unprocessed; foreach (OSHttpHandler h in handlers) { rc = h.Process(req); // Pass: handler did not process the request, // try next handler if (OSHttpHandlerResult.Pass == rc) continue; // Handled: handler has processed the request if (OSHttpHandlerResult.Done == rc) break; // hmm, something went wrong throw new Exception(String.Format("[{0}] got unexpected OSHttpHandlerResult {1}", EngineID, rc)); } if (OSHttpHandlerResult.Unprocessed == rc) { _log.InfoFormat("[{0}] OSHttpHandler: no handler registered for {1}", EngineID, req); // set up response header OSHttpResponse resp = new OSHttpResponse(req); resp.StatusCode = (int)OSHttpStatusCode.ClientErrorNotFound; resp.StatusDescription = String.Format("no handler on call for {0}", req); resp.ContentType = "text/html"; // add explanatory message StreamWriter body = new StreamWriter(resp.Body); body.WriteLine(""); body.WriteLine("
Ooops...
"); body.WriteLine(String.Format("

{0}

", resp.StatusDescription)); body.WriteLine(""); body.Flush(); // and ship it back resp.Send(); } } catch (Exception e) { _log.DebugFormat("[{0}] OSHttpHandler problem: {1}", EngineID, e.ToString()); _log.ErrorFormat("[{0}] OSHttpHandler problem: {1}", EngineID, e.Message); } } } protected List MatchHandlers(OSHttpRequest req, List handlers) { Dictionary scoredHandlers = new Dictionary(); _log.DebugFormat("[{0}] MatchHandlers for {1}", EngineID, req); foreach (OSHttpHandler h in handlers) { Regex pathRegex = h.Path; Dictionary headerRegexs = h.Headers; Regex endPointsRegex = h.IPEndPointWhitelist; // initial anchor scoredHandlers[h] = 0; // first, check whether IPEndPointWhitelist applies // and, if it does, whether client is on that white // list. if (null != endPointsRegex) { // TODO: following code requires code changes to // HttpServer.HttpRequest to become functional IPEndPoint remote = req.RemoteIPEndPoint; if (null != remote) { Match epm = endPointsRegex.Match(remote.ToString()); if (!epm.Success) continue; } } // whitelist ok, now check path if (null != pathRegex) { Match m = pathRegex.Match(req.HttpRequest.Uri.AbsolutePath); if (!m.Success) continue; scoredHandlers[h] = m.ToString().Length; } // whitelist & path ok, now check headers if (null != headerRegexs) { int headersMatch = 0; // go through all header Regexs and evaluate // match: // if header field not present or does not match: // remove handler from scoredHandlers // continue // else: // add increment headersMatch NameValueCollection headers = req.HttpRequest.Headers; foreach (string tag in headerRegexs.Keys) { // do we have a header "tag"? if (null == headers[tag]) { // no: remove the handler if it was added // earlier and on to the next one _LogDumpOSHttpHandler(String.Format("[{0}] dropping handler for {1}: null {2} header field", EngineID, req, tag), h); scoredHandlers.Remove(h); break; } // does the content of header "tag" match // the supplied regex? Match hm = headerRegexs[tag].Match(headers[tag]); if (!hm.Success) { // no: remove the handler if it was added // earlier and on to the next one _LogDumpOSHttpHandler(String.Format("[{0}] dropping handler for {1}: {2} header field content \"{3}\" does not match regex {4}", EngineID, req, tag, headers[tag], headerRegexs[tag].ToString()), h); scoredHandlers.Remove(h); break; } // if we are looking at the "content-type" tag, // check wether h has a ContentTypeChecker and // invoke it if it has if ((null != h.ContentTypeChecker) && !h.ContentTypeChecker(req)) { scoredHandlers.Remove(h); _LogDumpOSHttpHandler(String.Format("[{0}] dropping handler for {1}: content checker returned false", EngineID, req), h); break; } // ok: header matches headersMatch++; _LogDumpOSHttpHandler(String.Format("[{0}] MatchHandlers: found handler for {1}", EngineID, req), h); continue; } // check whether h got kicked out if (!scoredHandlers.ContainsKey(h)) continue; scoredHandlers[h] += headersMatch; } } foreach (OSHttpHandler hh in scoredHandlers.Keys) { _LogDumpOSHttpHandler("scoredHandlers:", hh); } List matchingHandlers = new List(scoredHandlers.Keys); _LogDumpOSHttpHandlerList("before sort: ", matchingHandlers); matchingHandlers.Sort(delegate(OSHttpHandler x, OSHttpHandler y) { return scoredHandlers[x] - scoredHandlers[y]; }); _LogDumpOSHttpHandlerList("after sort: ", matchingHandlers); return matchingHandlers; } [ConditionalAttribute("DEBUGGING")] private void _LogDumpOSHttpHandler(string msg, OSHttpHandler h) { _log.Debug(msg); StringWriter sw = new StringWriter(); sw.WriteLine("{0}", h.ToString()); sw.WriteLine(" path regex {0}", null == h.Path ? "null": h.Path.ToString()); foreach (string tag in h.Headers.Keys) { sw.WriteLine(" header[{0}] {1}", tag, h.Headers[tag].ToString()); } sw.WriteLine(" IP whitelist {0}", null == h.IPEndPointWhitelist ? "null" : h.IPEndPointWhitelist.ToString()); sw.WriteLine(); sw.Close(); _log.Debug(sw.ToString()); } [ConditionalAttribute("DEBUGGING")] private void _LogDumpOSHttpHandlerList(string msg, List l) { _log.DebugFormat("OSHttpHandlerList dump: {0}", msg); foreach (OSHttpHandler h in l) _LogDumpOSHttpHandler("OSHttpHandler", h); } } }