OSHttpHandler.cs

Go to the documentation of this file.

/*
 * 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.IO;
using System.Text.RegularExpressions;

namespace OpenSim.Framework.Servers.HttpServer
{
    public enum OSHttpHandlerResult
    {
        Unprocessed,
        Pass,
        Done,
    }

    public delegate bool OSHttpContentTypeChecker(OSHttpRequest req);

    public abstract class OSHttpHandler
    {
        public virtual Regex Method
        {
            get { return _method; }
        }
        protected Regex _method;

        public virtual Regex Path
        {
            get { return _path; }
        }
        protected Regex _path;

        public virtual Dictionary<string, Regex> Query
        {
            get { return _query; }
        }
        protected Dictionary<string, Regex> _query;

        public virtual Dictionary<string, Regex> Headers
        {
            get { return _headers; }
        }
        protected Dictionary<string, Regex> _headers;

        public virtual Regex IPEndPointWhitelist
        {
            get { return _ipEndPointRegex; }
        }
        protected Regex _ipEndPointRegex;


        public OSHttpHandler(Regex method, Regex path, Dictionary<string, Regex> query,
                             Dictionary<string, Regex> headers, Regex contentType, Regex whitelist)
        {
            _method = method;
            _path = path;
            _query = query;
            _ipEndPointRegex = whitelist;

            if (null == _headers && null != contentType)
            {
                _headers = new Dictionary<string, Regex>();
                _headers.Add("content-type", contentType);
            }
        }


        public abstract OSHttpHandlerResult Process(OSHttpRequest request);

        public override string ToString()
        {
            StringWriter sw = new StringWriter();
            sw.WriteLine("{0}", base.ToString());
            sw.WriteLine("    method regex     {0}", null == Method ? "null" : Method.ToString());
            sw.WriteLine("    path regex       {0}", null == Path ? "null": Path.ToString());
            foreach (string tag in Headers.Keys)
            {
                sw.WriteLine("    header           {0} : {1}", tag, Headers[tag].ToString());
            }
            sw.WriteLine("    IP whitelist     {0}", null == IPEndPointWhitelist ? "null" : IPEndPointWhitelist.ToString());
            sw.WriteLine();
            sw.Close();
            return sw.ToString();
        }
    }
}